This repository serves as a template for creating a Python library
-
Create a new repository in GitHub with this repo as a starting point
-
Change all occurences of
my_libraryto match the name of your new library -
Consider if the license should be modified.
The devcontainer.json specification provided in the .devcontainer folder provides a reference environment for development and testing. The dev container needs to be installed in order to use the setup. The devcontainer is based on the repo-wide Dockerfile provided, but a devcontainer specific Dockerfile can also be created if the development and productions needs diverge. If development of the library requires multiple services, consider using a docker-compose based devcontainer setup.
Ruff is the linter of choice, and the default provided setup is currently used. For configuration of Ruff for specific project needs directly in the pyproject.toml, see here.