Rapid prototyping requires boilerplate code
serial-sphinx distills field knowledge about using sphinx for uploading your documentation to readthedocs.org.
Follow the blog for more useful info.
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.
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.
Open-source CI. But not like Github-actions. Check the .woodpecker.yml for a tested standard workflow.
The passing goal for the code-coverage should be edited in the setup.cfg under the key addopts
FAQs
Biolerplate for Python packaging
We found that chembee demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
Malicious Go packages are impersonating popular libraries to install hidden loader malware on Linux and macOS, targeting developers with obfuscated payloads.
Security News
Bybit's $1.46B hack by North Korea's Lazarus Group pushes 2025 crypto losses to $1.6B in just two months, already surpassing all of 2024's $1.49B total.
Security News
OpenSSF has published OSPS Baseline, an initiative designed to establish a minimum set of security-related best practices for open source software projects.