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.

Griffe, pronounced "grif" (/ɡʁif/), is a french word that means "claw", but also "signature" in a familiar way. "On reconnaît bien là sa griffe."

Installation

pip install griffe

With uv:

uv tool install griffe

Usage

Dump JSON-serialized API

On the command line, pass the names of packages to the griffe dump command:

$ griffe dump httpx fastapi
{
  "httpx": {
    "name": "httpx",
    ...
  },
  "fastapi": {
    "name": "fastapi",
    ...
  }
}

See the Serializing chapter for more examples.

Check for API breaking changes

Pass a relative path to the griffe check command:

$ griffe check mypackage --verbose
mypackage/mymodule.py:10: MyClass.mymethod(myparam):
Parameter kind was changed:
  Old: positional or keyword
  New: keyword-only

For src layouts:

$ griffe check --search src mypackage --verbose
src/mypackage/mymodule.py:10: MyClass.mymethod(myparam):
Parameter kind was changed:
  Old: positional or keyword
  New: keyword-only

It's also possible to directly check packages from PyPI.org (or other indexes configured through PIP_INDEX_URL). This feature requires that you install Griffe with the pypi extra:

pip install griffe[pypi]

The command syntax is:

griffe check package_name -b project-name==2.0 -a project-name==1.0

See the Checking chapter for more examples.

Load and navigate data with Python

With Python, loading a package:

import griffe

fastapi = griffe.load("fastapi")

Finding breaking changes:

import griffe

previous = griffe.load_git("mypackage", ref="0.2.0")
current = griffe.load("mypackage")

for breakage in griffe.find_breaking_changes(previous, current):
    ...

See the Loading chapter for more examples.

Metadata

Release files for griffe 2.3.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for griffe 2.3.2
File	Size	Uploaded
griffe-2.3.2.tar.gz	437.6 kB	Oct 6, 2026	Details

Built distribution (wheel)

Table of built distributions (wheels) for griffe 2.3.2
File	Interpreter	ABI	Platform	Reset
griffe-2.3.2-py3-none-any.whl 5.1 kB Oct 6, 2026	Python 3	none	any	Details

Total release size: 442.6 kB

Release files / griffe-2.3.2.tar.gz

Download URL	griffe-2.3.2.tar.gz
Size	437.6 kB
Tags	Source
SHA-256 checksum How to use checksums	`8625bf98dbb02edb291aef77f2f1a17ae6c62d32a764f5bfed009e6010b2d538`
BLAKE2b-256 checksum How to use checksums	`07208446877884b2189cddf1304fd376d9bde2d1a6caf77e3980c5cdf5959245`
Upload date	Oct 6, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/7.0.0 CPython/3.14.7`

Release files / griffe-2.3.2-py3-none-any.whl

Download URL	griffe-2.3.2-py3-none-any.whl
Size	5.1 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`31f5217d19c7e732893260d558f92298c4c9c9d2b50f930a1e6dec3f6feb63cb`
BLAKE2b-256 checksum How to use checksums	`1009385273046ef74d336e15cdd1069a9c0699483134b0616dceb4174d4d1213`
Upload date	Oct 6, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/7.0.0 CPython/3.14.7`