Skip to content
Tidy CLI Logo

Keep your code clean and robust!

Tidy CLI simplifies your development process by combining essential tools like ruff, mypy, pydoclint, and pytest into a single, easy-to-use command-line interface. Perfect for maintaining code quality and running tests across Python projects of any size.

Key Features

  • Unified Linting: Combines ruff, mypy, and pydoclint in one command
  • Smart Formatting: Automatic code formatting with ruff
  • Integrated Testing: Run pytest with coverage reporting
  • Auto-fix: Automatically fix linting issues where possible
  • Interactive Mode: Review and apply fixes interactively
  • Flexible Execution: Target specific files, directories, or entire projects
  • Configurable: Skip tools, customize paths, and adapt to your workflow

Quick Start

pip install tidy-cli  # Python 3.10+
tidy-cli init         # Setup project
tidy-cli lint run     # Check code quality
tidy-cli pytest run  # Run tests

Documentation Structure

  • Tutorials - Step-by-step guides to get you started
  • How-to Guides - Practical solutions for common tasks
  • Reference - Complete command and configuration reference
  • Explanation - Understanding the concepts behind Tidy CLI

Contributing

Contributions are welcome! Check out our GitHub repository to get started.

License

This project is licensed under the MIT License.