diff options
| author |  MarkKoz <[email protected]> | 2021-02-03 13:56:52 -0800 |
|---|---|---|
| committer | MarkKoz <[email protected]> | 2021-02-04 14:50:01 -0800 |
| commit | 00201c7f63889f65d3f36cba61057c14e923116a (patch) | |
| tree | 1fa07e6220d6846da70bc33dc732e86343c82653 /README.md | |
| parent | Merge PR #88 - use protobuf to parse config (diff) | |
Move development environment guide to a separate file
The information is only relevant to developers. The README is what all
users will read; they shouldn't be subject to information that isn't
necessarily relevant to them.
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 95 |
1 files changed, 1 insertions, 94 deletions
@@ -67,100 +67,8 @@ If `pip`, `setuptools`, or `wheel` are dependencies or need to be exposed, then ## Development Environment -### Initial Setup +See [DEVELOPING.md](DEVELOPING.md). -A Python 3.9 interpreter and the [pipenv] package are required. Once those requirements are satisfied, install the project's dependencies: - -``` -pipenv sync --dev -``` - -Follow that up with setting up the pre-commit hook: - -``` -pipenv run precommit -``` - -Now Flake8 will run and lint staged changes whenever an attempt to commit the changes is made. Flake8 can still be invoked manually: - -``` -pipenv run lint -``` - -### Running snekbox - -The Docker image can be built with: - -``` -pipenv run build -``` - -Use Docker Compose to start snekbox: - -``` -docker-compose up -``` - -### Running Tests - -Tests are run through coverage.py using unittest. Before tests can run, the dev venv Docker image has to be built: - -``` -pipenv run builddev -``` - -Alternatively, the following command will build the image and then run the tests: - -``` -pipenv run testb -``` - -If the image doesn't need to be built, the tests can be run with: - -``` -pipenv run test -``` - -### Coverage - -To see a coverage report, run - -``` -pipenv run report -``` - -Alternatively, a report can be generated as HTML: - -``` -pipenv run coverage html -``` - -The HTML will output to `./htmlcov/` by default - - -### The `devsh` Helper Script - -This script starts a `bash` shell inside the venv Docker container and attaches to it. Unlike the production image, the venv image that is built by this script contains dev dependencies too. The project directory is mounted inside the container so any filesystem changes made inside the container affect the actual local project. - -#### Usage - -``` -pipenv run devsh [--build [--clean]] [bash_args ...] -``` - -* `--build` Build the venv Docker image -* `--clean` Clean up dangling Docker images (only works if `--build` precedes it) -* `bash_args` Arguments to pass to `/bin/bash` (for example `-c "echo hello"`). An interactive shell is launched if no arguments are given - -#### Invoking NsJail - -NsJail can be invoked in a more direct manner that does not require using a web server or its API. See `python -m snekbox --help`. Example usage: - -```bash -python -m snekbox 'print("hello world!")' --time_limit 0 -``` - -With this command, NsJail uses the same configuration normally used through the web API. It also has an alias, `pipenv run eval`. [1]: https://github.com/python-discord/snekbox/workflows/Lint,%20Test,%20Build,%20Push/badge.svg?branch=master [2]: https://github.com/python-discord/snekbox/actions?query=workflow%3A%22Lint%2C+Test%2C+Build%2C+Push%22+branch%3Amaster @@ -177,4 +85,3 @@ With this command, NsJail uses the same configuration normally used through the [falcon]: https://falconframework.org/ [gunicorn]: https://gunicorn.org/ [GitHub Container Registry]: https://github.com/orgs/python-discord/packages/container/package/snekbox -[pipenv]: https://docs.pipenv.org/en/latest/ |