Tools for requesting long-running process shut down gracefully.
Once you have the repository, change into its root directory, create a virtual environment, and install it.
$ git clone https://github.com/wkschwartz/wrapitup
$ cd wrapitup
$ python3 -m venv venv
$ source venv/bin/activate # may differ on Windows
(venv) $ pip install -e . # or python setup.py develop
The version lives in exactly one place, wrapitup/_version.py
.
Install prerequisites using
(venv) $ pip install -r tests/requirements.txt
Use
(venv) $ python -m unittest discover tests
On Windows, you can run the tests only with cmd.exe
. The tests pass in
PowerShell, but then PowerShell exits automatically. (By the way, if you want
to activate a virtual environment in PowerShell, you may need to execute
Set-ExecutionPolicy RemoteSigned
as Administrator first.) They do not run in
MinGW (which is what Git Bash uses) using winpty python
, and crash the
terminal without winpty
. I have not tested WrapItUp in Cygwin.
Then you can Mypy, Flake8, and Coverage.py as in .travis.yml
.
To build the documentation, use Sphinx.
First, install it, then switch to the docs
directory, and then build the
documentation in the format you want.
(venv) $ pip install -r docs/requirements.txt
(venv) $ cd docs
(venv) $ make html