This template repository can be used to create a new repository with the skeleton of a poetry-based Python library.
This is based on the general approach of simonw/python-lib, but with a different default structure.
A new repository based on this template can be created in Github or through cookiecutter.
The templating process can be run entirely in GitHub to create a new repository.
Start here: https://github.com/ajparsons/python-poetry-auto-template/generate
Add a one-line description of your repository, then click "Create repository from template".
This repo can also be used to set up a template offline using cookiecutter. To start the processs:
python -m cookiecutter https://github.com/ajparsons/python-poetry-auto-template/
The default package uses:
- poetry for package management,
- pytest for testing,
- black for linting,
- pyright for typechecking.
- GitHub Actions for CI and publishing.
New repositories include config files and Dockerfile for developing in VS Code or Codespaces, so the development process can happen end to end in Github. (Or not! Will still worked cloned locally).
The test suite contains meta tests for alignment between the __version__ of the package and the poetry version, and that the current version is documented in the change log.
The template version includes a default GitHub Action for testing on Python 3.8-3.10, and publishing to pypi.
By default, the test action requires pytest, black and pyright to return no errors.
The default licence is the MIT Licence. Change if needed.
- Set a GitHub Actions secret for PYPI_TOKEN.
- For the initial publish. In the Actions tab for a repo, trigger a manual workfork flow with the 'force to pypi' box ticked.
- Subsequently, if the poetry version is bumped and all tests pass - the GitHub Action will automatically publish on push to the main branch.
If you want to modify or extend this approach - the self-bootstrapping behaviour will only happen when a repo does not end in '-auto-template'. If you clone this repo, into a different user or org space, it will not self-bootstrap because the name is the same.
If you wanted to extend this into a basic django template - you might fork or clone the repo and call it 'django-auto-template'. This will not self-bootstrap, but new projects created from that template would.
This project defines several meta tests in tests/ that will:
- Attempt to provision a template with basic variables.
- Run the projects internal tests for self-integrity.
This requires the packages listed in requirements.dev.txt to be installed.