{"repo":"smarie/python-genbadge","free":true,"listed":false,"github":"https://github.com/smarie/python-genbadge","clone":"git clone https://github.com/smarie/python-genbadge.git","description":"A library to generate badges for typical checks (flake8, pytest, coverage, etc.)","language":"Python","stars":88,"topics":["commandline","cli","generate","badge","shield","svg","flake8","pytest","test","coverage"],"license":"BSD-3-Clause","category":"cli-tools","readme_excerpt":"python-genbadge Generate badges for tools that do not provide one. This is the readme for developers. The documentation for users is available here: https://smarie.github.io/python-genbadge/ 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-genbadge/issues nox setup This project uses nox to define all lifecycle tasks. In order to be able to run those tasks, you should create python 3.7 environment and install the requirements: You should then be able to list all available tasks using: Running the tests and generating the reports This project uses pytest so running pytest at the root folder will execute all tests on current environment. However it is a bit cumbersome to manage all requirements by hand ; it is easier to use nox to run pytest on all supported python environments with the correct package requirements: Tests and coverage reports are automatically generated under ./docs/reports for one of the sessions ( tests-3.7 ). If you wish to execute tests on a specific environment, use explicit session names, e.g. nox -s tests-3.6 . Editing the documentation 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 . However once again things are easier with nox . You can easily build and serve locall","default_branch":null,"files":null,"tree":[],"storefront":"/r/smarie","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/smarie/python-genbadge/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}