chembee 0.1.0

Biolerplate for Python packaging

serial-sphinx

Why?

Rapid prototyping requires boilerplate code

What?

serial-sphinx distills field knowledge about using sphinx for uploading your documentation to readthedocs.org. Follow the blog for more useful info.

Command snippets

rm -r docs 
cd docs
sphinx-quickstart

Copy the config file from the repository. Then, in the docs folder

sphinx-apidoc -o source/ ../<package_name>
make html

Make sure you follow the appropriate file structure outlined in the repository.

Push it to you repo with the configured webhook, and you are done.

Proper testing

Please make sure to setup some CI/CD pipeline. If you are avoiding commercial setups, then this is a problem.

For code quality, make sure you have great coverage by using pytest-cov. Check out the provided setup.cfg file.

Woodpecker CI

Open-source CI. But not like Github-actions. Check the .woodpecker.yml for a tested standard workflow.

Code-Coverage

The passing goal for the code-coverage should be edited in the setup.cfg under the key addopts