# Preen Documentation

An opinionated, agentic CLI for Python package hygiene and release.

## Overview

Preen is a tool that helps maintain Python projects by checking and fixing common issues like:

- Project structure and layout
- Version consistency
- CI/CD configuration
- Dependencies and imports
- Code quality checks

## Quick Start

```bash
# Install preen
pip install preen

# Check your project
preen check

# Sync project files and configuration
preen sync
```

## Documentation

```{toctree}
:maxdepth: 2
:caption: User Guide

installation
usage
configuration
checks
```

```{toctree}
:maxdepth: 2
:caption: API Reference

api
```