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 is available to sponsors only and 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.

Release files for griffe 1.6.0

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 1.6.0
File	Size	Uploaded
griffe-1.6.0.tar.gz	391.8 kB	Mar 1, 2025	Details

Built distribution (wheel)

Table of built distributions (wheels) for griffe 1.6.0
File	Interpreter	ABI	Platform	Reset
griffe-1.6.0-py3-none-any.whl 128.5 kB Mar 1, 2025	Python 3	none	any	Details

Total release size: 520.3 kB

Release files / griffe-1.6.0.tar.gz

Download URL	griffe-1.6.0.tar.gz
Size	391.8 kB
Tags	Source
SHA-256 checksum How to use checksums	`eb5758088b9c73ad61c7ac014f3cdfb4c57b5c2fcbfca69996584b702aefa354`
BLAKE2b-256 checksum How to use checksums	`a01ad467b93f5e0ea4edf3c1caef44cfdd53a4a498cb3a6bb722df4dd0fdd66a`
Upload date	Mar 1, 2025
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/6.1.0 CPython/3.13.2`

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

Download URL	griffe-1.6.0-py3-none-any.whl
Size	128.5 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`9f1dfe035d4715a244ed2050dfbceb05b1f470809ed4f6bb10ece5a7302f8dd1`
BLAKE2b-256 checksum How to use checksums	`bf025a22bc98d0aebb68c15ba70d2da1c84a5ef56048d79634e5f96cd2ba96e9`
Upload date	Mar 1, 2025
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/6.1.0 CPython/3.13.2`