PyFoundry

PyFoundry is a modern project template designed to simplify the initial setup of Python projects by providing a solid foundation with best practices built in from day one. It helps you avoid common setup pitfalls and enforces consistency so you can focus on what matters: writing great code.

Why PyFoundry?

  • Consistency: Includes EditorConfig and Ruff to maintain uniform code style and linting across your team.

  • Safety: Integrates MyPy for static type checking to catch bugs early.

  • Automation: Pre-configured pre-commit hooks automate code quality checks.

  • Productivity: Environment management and logging setup included for scalable projects.

  • Quality: Built-in testing and code coverage ensure reliability and maintainability.

With PyFoundry, starting your Python project is no longer a hurdle but a streamlined experience that scales from simple scripts to complex AI engineering workflows.

Contents

Project Initialization

The project is configured with tools that promote consistency and maintainability from the beginning:

  • editorconfig — Ensures consistent indentation, line endings, and formatting across different editors.

  • ruff — Ultra-fast linter and formatter for Python.

  • mypy — Static type checker for Python.

  • pre-commit — Framework for managing and maintaining multi-language pre-commit hooks.

Project Setup

The core project setup integrates tools for configuration, CLI handling, testing, and automation:

  • dynaconf — Flexible configuration management.

  • fire — CLI generation from Python code.

  • logging — Built-in logging configuration for visibility and debugging.

  • pytest — Simple yet powerful test framework.

  • coverage — Monitors code coverage during test execution.

  • pytest-cov — Plugin for integrating coverage with pytest.

  • tox — Automates testing across multiple Python environments.

Project deployment

Build docs with Sphinx, automate with GitHub Actions, and publish on GitHub Pages.

  • sphinx — For generating structured project documentation.

  • gh-actions — To automate documentation builds and deployment on every push or pull request, using a CI/CD pipeline.

  • gh-pages — Deploy documentation or project pages directly from the main branch using Sphinx.

Getting Started with uv

  1. Clone the repository

    git clone https://github.com/ghimiresunil/PyFoundry.git
cd PyFoundry

  2. Create a virtual environment

    uv venv .venv
source .venv/bin/activate

  3. Install project dependencies

    uv sync

Environment Examples

Sample .env.example file for Dynaconf environment:

ENV_FOR_DYNACONF=dev
DYNACONF_APP_NAME=PyFoundry

Sample .secrets.example file:

[default]
access_key = "my_access_key"
secret_key = "my_secret_key"
db_user_name = "username"
db_password = "password"

[dev]
access_key = "my_access_key-dev"
secret_key = "my_secret_key-dev"
db_user_name = "username-dev"
db_password = "password-dev"

[stage]
access_key = "my_access_key-stg"
secret_key = "my_secret_key-stg"
db_user_name = "username-stg"
db_password = "password-stg"

[prod]
access_key = "my_access_key-prod"
secret_key = "my_secret_key-prod"
db_user_name = "username-prod"
db_password = "password-prod"

Note

Replace .env.examples with .env to configure your working environment, and replace .secrets.examples.toml with .secrets.toml to store your actual secret values.

Make sure to exclude .secrets.toml from version control to keep your secrets secure.

Coming Soon

Planned future integrations:

  • PyPI Release — Prepare to publish the package to PyPI.

Contribute or Follow Along

PyFoundry is evolving. Star the repository, follow development, or contribute by submitting issues and pull requests!