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
With pip:
pip install griffe
With pipx:
python3.8 -m pip install --user pipx
pipx install griffe
Usage
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.
Or 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.
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.
1 maintainer
Release files for griffe 1.3.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 | |
|---|---|---|---|
| griffe-1.3.1.tar.gz | 382.4 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| griffe-1.3.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 509.3 kB
Release files / griffe-1.3.1.tar.gz
| Download URL | griffe-1.3.1.tar.gz |
|---|---|
| Size | 382.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
3f86a716b631a4c0f96a43cb75d05d3c85975003c20540426c0eba3b0581c56a
|
|
BLAKE2b-256 checksum How to use checksums |
aed1dcd486d6d577cb12490c78cfa88679fb9b481b227807f14632ba9bd82245
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.1.1 CPython/3.11.5
|
Release files / griffe-1.3.1-py3-none-any.whl
| Download URL | griffe-1.3.1-py3-none-any.whl |
|---|---|
| Size | 126.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
940aeb630bc3054b4369567f150b6365be6f11eef46b0ed8623aea96e6d17b19
|
|
BLAKE2b-256 checksum How to use checksums |
1b1963971981a20aecfa7cbd07c5cac6914cf1180b3dd8db5fe8ab2ea410315f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.1.1 CPython/3.11.5
|
