`pydoit` for humans: an API to create `doit` tasks faster and more reliably.
BSD-3-CLAUSE License
pydoit
for humans: an API to create doit
tasks faster and more reliably.
This is the readme for developers. The documentation for users is available here: https://smarie.github.io/python-doit-api/
Contributions are welcome ! Simply fork this project on github, commit your contributions, and create pull requests.
Here is a non-exhaustive list of interesting open topics: https://github.com/smarie/python-doit-api/issues
This project uses pytest
.
pytest
This project uses setuptools_scm
to synchronise the version number. Therefore the following command should be used for development snapshots as well as official releases:
python setup.py egg_info bdist_wheel rotate -m.whl -k3
This project uses mkdocs
to generate its documentation page. Therefore building a local copy of the doc page may be done using:
mkdocs build -f docs/mkdocs.yml
The following commands generate the html test report and the associated badge.
pytest --junitxml=junit.xml -v doit_api/tests/
ant -f ci_tools/generate-junit-html.xml
python ci_tools/generate-junit-badge.py
This project is now automatically deployed to PyPI when a tag is created. Anyway, for manual deployment we can use:
twine upload dist/* -r pypitest
twine upload dist/*