A easy, reliable, fluid template for python packages complete with docs, testing suites, readme's, github workflows, linting and much much more
You can install the package using pip
pip install -e .print("hello world")This project uses poetry, venv and pre-commit hooks.
Once on project set up run:
python -m venv /path/to/new/virtual/environment
where /path/to/new/virtual/environment is the path to the new virtual environment you want to create. I suggest /project/.venv as a good idea.
Then activate the virtual environment by running:
source .venv/bin/activate
When you are done working in this venv you can deactivate it by running:
source deactivate
We provide two handy commands inside the Makefile, namely:
make styleto format the codemake check_code_qualityto check code quality (PEP8 basically)black .ruff . --fix
pytests is used to run our tests.
Important: Before publishing, edit __version__ in src/init to match the wanted new version.
poetry build
poetry publish
We use GitHub actions to automatically run tests and check code quality when a new PR is done on main.
On any pull request, we will check the code quality and tests.
When a new release is created, we will try to push the new code to PyPi. We use twine to make our life easier.
The correct steps to create a new realease are the following:
- edit
__version__in src/init to match the wanted new version. - create a new
tagwith the release name, e.g.git tag v0.0.1 && git push origin v0.0.1or from the GitHub UI. - create a new release from GitHub UI
The CI will run when you create the new release.
We use MK docs. This repo comes with the zeta docs. All the docs configurations are already here along with the readthedocs configs.
MIT