mkdocstrings / griffe
Signatures for entire Python programs. Extract the structure, the frame, the skeleton of your project, to generate API documentation or find breaking changes in your API.
AI Architecture Analysis
This repository is indexed by RepoMind. By analyzing mkdocstrings/griffe in our AI interface, you can instantly generate complete architecture diagrams, visualize control flows, and perform automated security audits across the entire codebase.
Our Agentic Context Augmented Generation (Agentic CAG) engine loads full source files into context on-demand, avoiding the fragmentation of traditional RAG systems. Ask questions about the architecture, dependencies, or specific features to see it in action.
Embed this Badge
Showcase RepoMind's analysis directly in your repository's README.
Repository Overview (README excerpt)
Crawler viewGriffe Signatures for entire Python programs. Extract the structure, the frame, the skeleton of your project, to generate API documentation or find breaking changes in your API. Griffe, pronounced "grif" ( ), is a french word that means "claw", but also "signature" in a familiar way. "On reconnaît bien là sa griffe." • User guide • Contributor guide • API reference Installation With : Usage Dump JSON-serialized API **On the command line**, pass the names of packages to the command: See the Serializing chapter for more examples. Check for API breaking changes Pass a relative path to the command: For layouts: It's also possible to directly **check packages from PyPI.org** (or other indexes configured through ). This feature requires that you install Griffe with the extra: The command syntax is: See the Checking chapter for more examples. Load and navigate data with Python **With Python**, loading a package: Finding breaking changes: See the Loading chapter for more examples. Sponsors Silver sponsors Bronze sponsors --- *And 7 more private sponsor(s).*