README.md

Serious Scaffold Python

A Python Project Template for Long-Term Maintainability.

Warning

Serious Scaffold Python is in the Alpha phase. Frequent changes and instability should be anticipated. Any feedback, comments, suggestions and contributions are welcome!

Serious Scaffold Python is crafted for long-term, maintainable Python projects. It includes GitHub Actions and GitLab CI/CD, automated dependency updates via Renovate, and comprehensive linting, testing, and documentation. Key integrations like pdm for environment and dependency management, click for CLI development, and pydantic for configuration enhance project robustness. With copier’s easy project setup and continuous updating, your project stays aligned with best practices for sustainable development. Pre-configured dev containers and cross-platform CI support ensure maintainability from the start.

If you find this helpful, please consider sponsorship.

🛠️ Features

• Project setup and template update with copier.
• Manage dependencies and virtual environments with pdm.
• Build with setuptools and versioned with setuptools-scm.
• Lint with pre-commit, mypy, ruff, pyproject-fmt and commitlint.
• Test with pytest and coverage for threshold and reports.
• Documentation with sphinx, the furo theme and MyST parser for markdown.
• Develop Command Line Interfaces with click.
• Manage configurations with pydantic-settings.
• Dev container for development and GitLab CI/CD.
• Automate dependency updates with Renovate.
• Automate version management and release with semantic-release.
• Versioned documentation and pull request previews with Read the Docs.
• Adapted configuration for GitHub, GitLab and self-managed GitLab.
• Continuous Integration for Linux, MacOS and Windows [GitHub Only].
• Continuous Integration for multiple Python versions.
• Release with documentation, package and production container.
• Centralize common actions with a unified Makefile.
• VSCode settings with recommended extensions.

🔧 Prerequisites

pipx is required to manage the standalone tools used across the development lifecycle. Please refer to pipx's installation instructions here. Once pipx is set up, install the copier for project generation using the following command:

pipx install copier==9.4.1

🚀 Quickstart

1. Generate the project.

   copier copy gh:serious-scaffold/ss-python /path/to/project

2. Navigate to the project directory and initialize a git repository.

   cd /path/to/project
   git init

3. Install standalone tools.

   make prerequisites

4. Set up the development environment.

   make dev

5. Commit the initialized project.

   git add .
   git commit -m "Initialize from serious-scaffold."

6. That's it! Feel free to focus on the coding within src folder.

📜 License

MIT License, for more details, see the LICENSE file.