python-template-project 0.1.19

Feature-rich Python project template designed for robustness and ease of use.

Welcome to python-template-project

A feature-rich Python project template with with auto-generated CLI, GUI and parameterized configuration.

This template provides a solid foundation for your next Python project, incorporating best practices for testing, automation, and distribution. It streamlines the development process with a comprehensive set of pre-configured tools and workflows, allowing you to focus on writing code.

Installation

Download from PyPI.

💾 For more installation options see install.

pip install python-template-project

Run GUI from command line

python-template-project-gui

How to use this template

🐍 For details, see the Getting Started guide.

Feature overview

• 📦 Package Management: Utilizes uv, an extremely fast Python package manager, with dependencies managed in pyproject.toml.
• ✅ Code Formatting and Linting: Pre-commit hook with the RUFF auto-formatter to ensure consistent code style.
• 🧪 Testing: Unit testing framework with pytest.
• 📊 Code coverage reports using codecov
• 🔄 CI/CD: GitHub Actions for automated builds (Windows, macOS), unit tests, and code checks.
• 💾 Automated Builds: GitHub pipeline for automatically building a Windows executable and a macOS installer.
• 💬 Parameter-Driven Automation:
  • Automatic generation of a configuration file from parameter definitions.
  • Automatic generation of a Command-Line Interface (CLI) from the same parameters.
  • Automatic generation of CLI API documentation.
  • Automatic generation of change log using gitchangelog to keep a HISTORY.md file up to date.
• 📃 Documentation: Configuration for publishing documentation on Read the Docs using mkdocs .
• 🖼️ Minimalist GUI: Comes with a basic GUI based on tkinker that includes an auto-generated settings menu based on your defined parameters.
• 🖥️ Workflow Automation: A Makefile is included to simplify and automate common development tasks.
• 🛳️ Release pipeline: Automated releases unsing the Makefile make release command, which creates a new tag and pushes it to the remote repo. The release pipeline will automatically create a new release on GitHub and trigger a release on [PyPI](https://pypi.org.
  • setuptools is used to package the project and manage dependencies.
  • setuptools-scm is used to automatically generate the _version.py file from the pyproject.toml file.