pycutter 🔪

A highly opinionated Python template built for Human 👤 and AI 🤖 devs, featuring AI-friendly configurations for Cursor, CodeRabbit, and future AI tools. Your AI collegues deserve better 💪

🚀 Features

• Modern Python 3.12 setup
• Poetry for dependency management
• Ruff for lightning-fast linting
• Pytest with coverage reporting
• Deptry for dependency analysis
• GitHub Actions CI pipeline
• Pre-configured settings for:
  • Type checking with mypy
  • Code formatting
  • Git ignore patterns
  • Dependency analysis with Deptry
  • Cursor prompt
  • CodeRabbit AI code review

📦 Project Structure

cookiecutter-python-template/
├── assets/
│   └── logo.png
├── cookiecutter.json
├── hooks/
│   └── post_gen_project.py
└── {{cookiecutter.project_slug}}/
    ├── .github/
    │   └── workflows/
    │       └── ci.yml
    ├── {{cookiecutter.project_slug}}/
    │   ├── __init__.py
    │   ├── settings/
    │   │   ├── __init__.py
    │   │   └── settings.py
    │   └── main.py
    ├── tests/
    │   ├── __init__.py
    │   └── test_main.py
    ├── .gitignore
    ├── .cursorrules
    ├── .coderabbit.yaml
    ├── makefile
    ├── pyproject.toml
    └── README.md

🛠️ Quick Start

1. First, ensure you have cookiecutter installed:

pip install -U cookiecutter

2. Create a new repository on GitHub (or other git provider)

3. Generate a new Python project:

cookiecutter https://github.com/rrozb/pycutter.git

4. Set up remote repository:

git remote add origin <your-repo-url>
git branch -M main

5. Commit and push:

git add .
git commit -m "Initial commit"
git push origin main

6. Start coding 💻 & follow the new project's README.md.

📋 Requirements

• Python 3.12+
• Cookiecutter
• Poetry (will be installed automatically)

🤝 Contributing

Contributions are welcome! Here's how you can help:

1. Fork the repository
2. Create a new branch (git checkout -b feature/amazing-feature)
3. Make your changes
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

Or just open an issue 😊

What is next

• Figure out how to improve repo for Devin
• Add a guide for AI assisted development.
• Add documentation support.

🙏 Acknowledgments

• Built with Cookiecutter
• Coded with Cursor and Claude
• Logo made with Gemini 2