python-fprules
make
-like file pattern rules for build tools such as doit
.
This is the readme for developers. The documentation for users is available here: https://smarie.github.io/python-fprules/
Want to contribute ?
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-fprules/issues
Requirements for builds
Install requirements for setup beforehand using
pip install -r ci_tools/requirements-pip.txt
Running the tests
This project uses pytest
.
pytest -v fprules/tests/
Packaging
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
Generating the documentation page
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
Generating the test reports
The following commands generate the html test report and the associated badge.
pytest --junitxml=junit.xml -v fprules/tests/
ant -f ci_tools/generate-junit-html.xml
python ci_tools/generate-junit-badge.py
PyPI Releasing memo
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/*