Show HN: Griffe, load Python APIs, find breaking changes(mkdocstrings.github.io)
mkdocstrings.github.io
Show HN: Griffe, load Python APIs, find breaking changes
https://mkdocstrings.github.io/griffe/
0 comments
—
https://mkdocstrings.github.io/griffe/
—
Griffe is a Python tool and library to load Python APIs as whole program signatures, kinda. With this data, static site generators can generate API docs. Griffe itself can use the data to compare two versions of your API and find breaking changes. No excuses for not bumping your major semver version now!
Griffe is used by mkdocstrings (I'm the author too), and therefore indirectly used by FastAPI, Pydantic, and many other cool projects :)
The docs provide a lot of hints, advice, recommendations for public APIs, deprecations, and Python code generally. They somewhat come from my own experience, and not everyone might share my opinions: happy to discuss about all this!