python-template-project 0.1.15

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.

Feature overview

• Testing: Unit testing setup with pytest.
• CI/CD: GitHub Actions for automated builds (Windows, macOS), unit tests, and code checks.
• Code Formatting and Linting: Pre-commit hook with the RUFF auto-formatter to ensure consistent code style.
• Automated Builds: GitHub pipeline for automatically building a Windows executable and a macOS installer.
• Package Management: Utilizes uv, an extremely fast Python package manager, with dependencies managed in pyproject.toml.
• 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.
• Documentation: Configuration for publishing documentation on Read the Docs using mkdocs .
• Workflow Automation: A Makefile is included to simplify and automate common development tasks.
• Minimalist GUI: Comes with a basic GUI based on tkinker that includes an auto-generated settings menu based on your defined parameters.
• 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.
  • 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.

Getting started

1. Create a new github repository.
2. Clone github repository the into your local file system.

   git clone https://github.com/YOUR-USERNAME/YOUR-REPOSITORY
   

3. Install uv package and project manager

   pip install uv
   

4. Generate a sample project with uv
5. Add and push the artifacts to your github repository

   git push
   

6. Copy the content of this repository into your repository

Troubleshooting

Problems with release pipeline

If you get this error below:

/home/runner/work/_temp/xxxx_xxx.sh: line 1: .github/release_message.sh: Permission denied

You have to run these commands in your IDE Terminal or the git bash and then push the changes.

git update-index --chmod=+x ./.github/release_message.sh