python-project-template Documentation

python-project-template is a minimal Python project aimed at demonstrating good coding practices.

The library provides a small dependency-free Calculator API (Operation, OperationRegistry, Calculator) that can register and compose simple mathematical operations. This code is used to showcase a number of good software practices. See the next page for a detailed list.

Contents:

• Features
• Installation
• Tests
  • Running the tests manually
  • GitHub Actions workflow for testing
• Usage example
• Documentation (local)
• Documentation (GitHub Actions)
  • Repository setup (one-time)
  • Troubleshooting
• Release procedure
  • Prerequisites
  • Release checklist
  • Deleting tags
  • Removing GitHub Releases
  • Notes and tips
  • Changelog and release notes
  • Acknowledgments
• Project Structure
• API Reference
  • python_project_template_AS.calculator
  • python_project_template_AS.operations
  • python_project_template_AS.registry
  • python_project_template_AS.exceptions
  • python_project_template_AS.utils

Indices and tables

• Index

• Module Index

• Search Page