rcrab 0.1.0

Simpe python project template

🦀 Crab - Modern Python Project Manager

Crab is a batteries-included CLI tool that streamlines Python project setup and management by automating boilerplate configuration and integrating modern development tools.

Features

• 🚀 Quick Project Setup: Create new Python projects with best practices using crab init
• 🛠 Modern Tooling: Pre-configured integration with:
  • uv for fast package management
  • ruff for linting and formatting
  • mypy for type checking
  • pytest for testing
  • pre-commit for git hooks
• ⚙️ PEP-Compliant: Uses pyproject.toml for configuration
• 🔄 Git Integration: Automatic git repository initialization
• 📦 Dependency Management: Simple commands to add, remove, and update packages

Installation

pip install crab-cli

Quick Start

1. Create a new project

crab init my_project
cd my_project

2. Add dependencies:

uv add pandas numpy

3. Run code quality tools:

make lint
make fix

4. Run test

make test

Configuration

Crab uses pyproject.toml for project configuration. Default settings are automatically created during project initialization.

Example configuration:

[tool.crab]
template = "basic"
venv-directory = ".venv"

[tool.crab.paths]
source = "src"
tests = "tests"
docs = "docs"

[tool.crab.lint]
enabled-tools = ["ruff", "mypy"]