README.md

Python Project Template

A minimal Python project template following modern best practices and industry standards.

Author: JacobPEvans Created: July 12, 2025 License: Apache License 2.0 Python Version: 3.11+

🚀 Quick Start

Prerequisites

• Python 3.11 or higher
• Git

Installation

1. Clone this repository

   git clone <repository-url>
   cd python-template

2. Create and activate a virtual environment

   # Windows
   python -m venv .venv
   .\.venv\Scripts\Activate.ps1
   
   # Linux/macOS
   python3 -m venv .venv
   source .venv/bin/activate

   Note: We use .venv as the directory name to match common conventions and ensure it's ignored by git.

3. Install dependencies

   # Development installation (includes dev dependencies)
   pip install -e ".[dev]"
   
   # Or just production dependencies
   pip install -e .

   Note: The -e flag installs in "editable" mode, so changes to your code take effect immediately.

4. Set up pre-commit hooks (Required for contributing)

   # Pre-commit is already installed with dev dependencies
   # Install the git hook scripts
   pre-commit install
   
   # (Optional) Run on all files to test setup
   pre-commit run --all-files

   Note: Pre-commit hooks will run automatically on every commit and may auto-fix formatting issues.

🧪 Running Tests

# Run all tests
pytest

# Run tests with coverage
pytest --cov=src/hello_world --cov-report=html

# Run tests with coverage (same as GitHub Actions/CodeCov) - REQUIRES 100% coverage
pytest --cov --cov-branch --cov-report=xml --cov-fail-under=100

# Run tests in verbose mode
pytest -v

# Run specific test file
pytest tests/test_main.py -v

100% Code Coverage Required**

This project enforces 100% code coverage. All pull requests must maintain 100% coverage or they will be automatically rejected by GitHub Actions.

Use pytest --cov --cov-branch --cov-report=xml --cov-fail-under=100 to ensure your changes meet this requirement before committing.

🛠️ Development Tools

Code Quality & Pre-commit

This project uses multiple workflows for maintaining code quality:

GitHub Actions

• tests.yml: Runs pytest with coverage across Python 3.11-3.13
• ci.yml: Enforces code quality with auto-fixing and validation

Pre-commit Hooks Setup

Pre-commit hooks automatically run code formatting, linting, and type checking before each commit to ensure code quality.

# Pre-commit is already installed with dev dependencies
# Install the git hook scripts
pre-commit install

# Test the setup
pre-commit run --all-files

Note: Once installed, pre-commit will automatically run on every git commit. If any checks fail, the commit will be blocked until issues are fixed. Code formatting tools like Black and isort will auto-fix many issues.

Features

• ✅ Modern Python packaging with pyproject.toml
• ✅ Automated testing with pytest and coverage
• ✅ Dual GitHub Actions workflows (testing + code quality)
• ✅ Pre-commit hooks for code quality enforcement
• ✅ Type hints and mypy type checking
• ✅ Code formatting with Black and isort
• ✅ Linting with flake8
• ✅ Pre-configured .gitignore

Project Structure

python-template/
├── .github/
│   └── workflows/
│       ├── tests.yml          # GitHub Actions - Testing
│       └── ci.yml             # GitHub Actions - Code Quality
├── src/
│   └── hello_world/
│       ├── __init__.py        # Package initialization
│       └── main.py            # Main application code
├── tests/
│   ├── __init__.py            # Test package initialization
│   └── test_main.py           # Unit tests
├── .gitignore                 # Git ignore rules
├── .pre-commit-config.yaml    # Pre-commit hooks configuration
├── README.md                  # Project documentation
├── pyproject.toml             # Modern Python packaging & tool config
├── pytest.ini                # Pytest configuration
└── requirements-dev.txt       # Development dependencies

Quick Setup (Alternative)

If you prefer the minimal approach:

1. Clone the repository:

   git clone <repository-url>
   cd python-template

2. Create a virtual environment:

   python3 -m venv .venv
   source .venv/bin/activate  # On Windows: .\.venv\Scripts\activate

3. Install dependencies:

   pip install -e ".[dev]"

Usage

Run the hello world application:

python -m hello_world.main

Or import and use in your code:

from hello_world import greet

print(greet("Python"))  # Output: Hello, Python!

Development

Running Tests

pytest tests/ -v

Running Tests with Coverage

# Generate HTML coverage report
pytest tests/ -v --cov=src/hello_world --cov-report=html

# Generate XML coverage report (used by CodeCov in CI)
pytest --cov --cov-branch --cov-report=xml --cov-fail-under=100

Installing in Development Mode

pip install -e .

Contributing

1. Fork the repository
2. Create a feature branch (git checkout -b feature/amazing-feature)
3. Run tests with coverage before committing (see coverage requirements above)
4. Commit your changes (git commit -m 'Add some amazing feature')
5. Push to the branch (git push origin feature/amazing-feature)
6. Open a Pull Request