Opinionated set of tools for developing in Python Reproducible, robust and yet simple development setup for python. By a data person that loves developing using VSCode devcontainer.
# Clone the repository
git clone <this-repo>
cd <this-repo>
# create .env for configs and secrets, see .env.sample
cp .env.sample .env
# Update .env with your settings as needed
# DEVELOPMENT=True enables debug logging
# Open the project in VSCode
code .
# Use the VSCode command palette (Ctrl+Shift+P) and select:
# > Dev Containers: Reopen in Container
# This will build and open the development container
# --- Inside the container ---
# Dependencies are managed with uv (part of the `builder` stage)
# To add new dependencies
uv add <package-name>
# Pre-commit hooks are installed with postCreateCommand in .devcontainer/devcontainer.json
pre-commit
# You're ready to develop!This template uses VSCode's Development Containers (devcontainers) to provide a consistent, isolated development environment. The setup leverages Docker Compose with an extension pattern:
docker-compose.ymldefines the base service configuration.devcontainer/docker-compose.extend.ymlextends the base configuration specifically for development- The extension mounts your local project directory to
/appin the container, enabling real-time file synchronization - This allows you to work on code locally in VSCode while running it in a container environment
This approach ensures that all developers work with identical dependencies and configurations, regardless of their local setup, while maintaining the ability to edit files directly on the host system.
uvfor dependency management- VS Code devcontainers with
docker compose-file - Multi-stage build with
builder, also used for development, andproduction - debugging:
debugpy - testing:
pytest- (optional) pytest-cov, pytest-mock, hypothesis, nox
- linting & formatting:
ruff - type-checking:
mypy - environment variables:
python-dotenv pre-commithooks
- write commits following The seven rules of a great commit message: What and why in imperative mood instead of how
- follow 12-factor principles
- agree on git workflow, for example trunk-based development
- Use multi-stage builds to structure docker images and only include the needed runtime dependencies for smaller image size and faster builds
- Follow a styleguide like Google Python Style Guide
- Tag releases with SemVer:2.0.0 or CalVer
- For a changelog, adapt principles of common-changelog, written by humans for humans, a clean git history as foundation
- release with tags and changelog using
git-release