py-scaffolding

My custom Python project scaffolding repository: https://github.com/lordgordon/py-scaffolding.

Docker images published at https://hub.docker.com/repository/docker/lordgordon/py-scaffolding.

👉 Note: to release the project as a Python library, you need to run uv build and add the proper ci/cd to publish the library.

---

Requirements and setup

• brew.
• Linux/UNIX compatible system with make command.
• Docker. For macOS users, colima is strongly suggested.
• uv.

Then, to set everything up on macOS:

brew install uv
make install
make

Release and Changelog

Version bump and changelog update:

# PATCH
uv run cz bump --increment PATCH -ch --dry-run
# MINOR
uv run cz bump --increment MINOR -ch --dry-run
# MAJOR
uv run cz bump --increment MAJOR -ch --dry-run

If OK, run again without --dry-run. For full details see https://commitizen-tools.github.io/commitizen/bump/.

Commands

The main command that run everything (lint, test, build):

make

Then, to execute the main entry point with the local Python environment:

make run-locally

or, to execute the main entry point from Docker using the production image:

make run

or, to open a shell in the testing Docker image:

make run-shell-testing

Makefile commands

make help