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.
Sponsors
And 4 more private sponsor(s).
1 maintainer
Metadata
1 maintainer
Release files for griffe 2.4.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| griffe-2.4.1.tar.gz | 450.8 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| griffe-2.4.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 455.9 kB
Release files / griffe-2.4.1.tar.gz
| Download URL | griffe-2.4.1.tar.gz |
|---|---|
| Size | 450.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
766123e26ec35b2ead63202e9e43ec309d876085d571b7df288256cd6fe4a3ef
|
|
BLAKE2b-256 checksum How to use checksums |
33a4be055b9ced02e39ac0ab85960e0ed3d8c6017c03e90965e77ff276684418
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.15.0
|
Release files / griffe-2.4.1-py3-none-any.whl
| Download URL | griffe-2.4.1-py3-none-any.whl |
|---|---|
| Size | 5.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
ca58ccdb1d8590ad062fad837a875dd704f94acf7a0104795a098a991ceaf728
|
|
BLAKE2b-256 checksum How to use checksums |
299367a1814b4b13e9a5cc02510dbfa1d3937603140192a701c96d861b272611
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.15.0
|
Security for griffe 2.4.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
