Skip to content

Latest commit

 

History

History
94 lines (78 loc) · 3.61 KB

README.md

File metadata and controls

94 lines (78 loc) · 3.61 KB
Raw

griffe

ci documentation pypi version gitpod gitter

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.7 -m pip install --user pipx
pipx install griffe

Usage

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

$ griffe httpx fastapi
[
  {
    "name": "httpx",
    ...
  }
]

See the Usage section for more examples.

With Python:

from griffe.loader import GriffeLoader

griffe = GriffeLoader()
fastapi = griffe.load_module("fastapi")

See the Usage section for more examples.

Todo

  • Visitor/Inspector:
    • Merging inherited members into class. Needs to be able to post-process classes, and to compute their MRO (C3Linearization, see docspec/pydocspec issues).
  • Extensions
    • Post-processing extensions
    • Third-party libraries we could provide support for:
      • Django support
      • Marshmallow support
      • Pydantic support
  • Docstrings parsers
    • epydoc
    • New Markdown-based format? For graceful degradation
  • Serializer:
    • Flat JSON
    • JSON schema
  • API diff:
    • Mecanism to cache APIs? Should users version them, or store them somewhere (docs)?
    • Ability to return warnings (things that are not backward-compatibility-friendly)
    • List of things to consider for warnings
      • Multiple positional-or-keyword parameters
      • Public imports in public modules
      • Private things made public through imports/assignments
      • Too many public things? Generally annoying. Configuration?
    • Ability to compare two APIs to return breaking changes
    • List of things to consider for breaking changes
      • Changed position of positional only parameter
      • Changed position of positional or keyword parameter
      • Changed type of parameter
      • Changed type of public module attribute
      • Changed return type of a public function/method
      • Added parameter without a default value
      • Removed keyword-only parameter without a default value, without **kwargs to swallow it
      • Removed positional-only parameter without a default value, without *args to swallow it
      • Removed positional-or_keyword argument without a default value, without *args and **kwargs to swallow it
      • Removed public module/class/function/method/attribute
      • All of the previous even when parent is private (could be publicly imported or assigned somewhere), and later be smarter: public assign/import makes private things public!
      • Inheritance: removed base, or added/changed base that changes MRO