Skip to content

Latest commit

 

History

History
39 lines (28 loc) · 954 Bytes

README.md

File metadata and controls

39 lines (28 loc) · 954 Bytes

python-project-starter

This is a template repo to act as a reference when starting up a new project in python. It consolidates best practices in regards to minimal level of documentation as well as the CI aspects.

Local installation can be done using uv:

$ uv venv -p python3.10
$ uv pip install -e .
$ source .venv/bin/activate
$ python
>>> from package import square
>>> square(3)
9

After installation a command-line tool is also available:

$ square 4
Square of 4 is 16

Running the tests can be done using tox:

$ tox -p

Building the packages can also be done using tox:

$ tox -e packages
$ ls dist/

Packaging uses setuptools-scm, so the version of the software is based on git tags.

To run the linting, we recommend ruff, a standard configuration is in the repo in pyproject.toml.