Metadata-Version: 2.3
Name: classify
Version: 2026.7.1
Summary: Generate concrete Class documentation for Python Classes
Author: George Hickman
Author-email: George Hickman <george@ghickman.co.uk>
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Documentation
Requires-Dist: attrs>=25.4.0
Requires-Dist: click>=8.3.0
Requires-Dist: jinja2>=2.7
Requires-Dist: rich>=14.2.0
Requires-Dist: structlog>=25.5.0
Requires-Python: >=3.12
Project-URL: Repository, https://github.com/ghickman/classify/
Project-URL: Changelog, https://github.com/ghickman/classify/blob/main/CHANGELOG.md
Description-Content-Type: text/markdown

# Classify
Generate concrete class API documentation for python Classes

## Installation
```bash
    pip install classify
```


## Usage
```bash
    classify <path.to.Class>
```

This outputs the full class definition, including the methods defined on each parent class.

You can change the theme to any [Pygments theme](https://pygments.org/styles/) with `--console-theme`.

Output to your shell's pager with `--renderer pager`, or to [ccbv style pages](https://ccbv.co.uk) with `--renderer html`.

By default HTML documents are saved to a temporary directory.
To change this specify a relative location with the `--output` option.
You can serve the output, regardless of where its written to with `--serve`, and change the port with `--port`.

```bash
    classify <path.to.Class> --renderer html --output output --serve --port 8080
```


## Why?
[CCBV](https://ccbv.co.uk) has long been a part of my everyday toolkit for working with Django's generic class-based views.
It's a fantastic resource for quick reference, but it only covers Django's GCBVs.

Classify aims to provide this same level of utility for all your Python classes.
