Skip to content

Show HN: Griffe, load Python APIs, find breaking changes

mkdocstrings.github.io
3 pointsPawamoydiscuss
On HN

Hey all, Griffe was already submitted two years ago on HN, but it nicely evolved since then so I figured I'd submit it again myself, especially since I just finished rewriting its documentation and reworking its API :)

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!

Comments

No comments yet.

AboutSource Built by g1lg1l

Hackerly is an independent reader for Hacker News, built on the public HN API. Not affiliated with Y Combinator.