Skip to content

Latest commit

 

History

History
34 lines (23 loc) · 1.11 KB

README.md

File metadata and controls

34 lines (23 loc) · 1.11 KB

Classify

Generate concrete class API documentation for python Classes

Installation

    pip install classify

Usage

    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 with --console-theme.

Output to your shell's pager with --renderer pager, or to ccbv style pages 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.

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

Why?

CCBV 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.