inv tasks defined by atelier¶
- inv bd¶
Build docs. Build all Sphinx HTML doctrees for this project.
- inv pd¶
Publish docs. Upload docs to public web server.
- inv blog¶
Edit today’s blog entry, create an empty file if it doesn’t yet exist.
- inv readme¶
Generate or update README.txt or README.rst file from SETUP_INFO.
- inv ci¶
Checkin and push to repository, using today’s blog entry as commit message.
Asks confirmation before doing so.
Does nothing in a project whose
In a project whose
'git'it checks whether the repository is dirty (i.e. has uncommitted changes) and returns without asking confirmation if the repo is clean. Note that unlike
git status, this check does currently not (yet) check whether my branch is up-to-date with ‘origin/master’.
- inv reg¶
Register this project (and its current version) to PyPI.
- inv release¶
Upload the source distribution archive previously created by
inv sdistto PyPI, i.e. publish an official version of your package.
Before doing anything, it shows the status of your local repository (which should be clean) and a summary of the project status on PyPI. It then asks a confirmation (unless you specified
The release will fail if the project has previously been published on PyPI with the same version.
If you specified
'git'), create and push a version branch “vX.Y.Z”.
This command requires that twine is installed.
- inv install¶
Install required Python packages to your Python environment and/or to your
Don’t ask for confirmations.
Don’t install anything, just list the requirements to stdout.
- inv prep¶
Run preparation tasks that need to run before testing.
- inv test¶
Run the test suite of this project.
This is a shortcut for either
python setup.py testor
py.testor `` tox`` (depending on whether your project has a
tox.inifiles or not and ).
- inv cov¶
Create a coverage report.
You can configure the command to use by setting
- inv test_sdist¶
Creates and activates a temporay virtualenv, installs your project and runs your test suite.
creates and activates a temporay virtualenv,
pip install --no-index -f <env.sdist_dir> <prjname>
python setup.py test
removes temporary files.
Assumes that you previously did
inv sdistof all your projects related to this project.
- inv clean¶
Remove temporary and generated files:
additional files specified in
--batchis specified, ask for an interactive user confirmation before removing these files.
- inv ct¶
Display a list of commits in all projects during the last 24 hours.
- inv check¶
Perform an integrity check for this project. Experimental.