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 .├── LICENSE
├── Makefile
├── README.md
├── agorabanner.png
├── example.py
├── package
│ ├── __init__.py
│ ├── main.py
│ └── subfolder
│ ├── __init__.py
│ └── main.py
├── pyproject.toml
└── requirements.txt
2 directories, 11 files
We provide two handy commands inside the Makefile, namely:
make styleto format the codemake check_code_qualityto check code quality (PEP8 basically)
So far, there is no types checking with mypy. See issue.
pytests is used to run our tests.
Important: Before publishing, edit __version__ in src/init to match the wanted new version.
We use twine to make our life easier. You can publish by using
export PYPI_USERNAME="you_username"
export PYPI_PASSWORD="your_password"
export PYPI_TEST_PASSWORD="your_password_for_test_pypi"
make publish -e PYPI_USERNAME=$PYPI_USERNAME -e PYPI_PASSWORD=$PYPI_PASSWORD -e PYPI_TEST_PASSWORD=$PYPI_TEST_PASSWORD
You can also use token for auth, see pypi doc. In that case,
export PYPI_USERNAME="__token__"
export PYPI_PASSWORD="your_token"
export PYPI_TEST_PASSWORD="your_token_for_test_pypi"
make publish -e PYPI_USERNAME=$PYPI_USERNAME -e PYPI_PASSWORD=$PYPI_PASSWORD -e PYPI_TEST_PASSWORD=$PYPI_TEST_PASSWORD
Note: We will try to push to test pypi before pushing to pypi, to assert everything will work
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
This is a template repo, it's meant to be used inside GitHub upon repo creation.
There are several very good templates on GitHub, I prefer to use code we wrote instead of blinding taking the most starred template and having features we don't need. From experience, it's better to keep it simple and general enough for our specific use cases.
MIT