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 Dumping data section 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/
|
Forgot your password?
New user?
python3-plone-app-caching-3.1.5-1.lbn36.noarch
Builder
