catface s a Command Line Interface (CLI) tool that helps you create Python projects with best practices built-in. It uses cookiecutter under the hood to provide project templates that you can customize based on your needs.

Features

• Documentation (MkDocs)

  • Automatic API documentation
  • Material design theme
  • Ready-to-deploy structure

• Docker Integration

  • Multi-stage builds
  • Production-ready configuration
  • Python version specific base images

• Development Tools

  • Pre-commit hooks for code quality
  • Ruff for fast linting and formatting
  • Tox for testing across Python versions

Quick Start

# Install Catface
pip install catface

# Create a new project
catface my-awesome-project

Project structure

The final project structure is going to be something like this based on the features you choose.

Pre-configured Tox file

• Task automation: Using Tox we can automate repetitive tasks
• Test against multiple Python versions
• Environment management: Using Tox we can create different environments each with its dependencies
• Lint and format code using Ruff

# Cd inside your project
cd my-awesome-project

tox # runs all environments
tox -e <env_name> # running each environment individually by name
tox -p all # parallel execution