mkdocstrings
fastapi
Our great sponsors
mkdocstrings | fastapi | |
---|---|---|
9 | 466 | |
1,572 | 71,023 | |
3.4% | - | |
8.4 | 9.8 | |
2 days ago | 2 days ago | |
Python | Python | |
ISC License | MIT License |
Stars - the number of stars that a project has on GitHub. Growth - month over month growth in stars.
Activity is a relative number indicating how actively a project is being developed. Recent commits have higher weight than older ones.
For example, an activity of 9.0 indicates that a project is amongst the top 10% of the most actively developed projects that we are tracking.
mkdocstrings
-
Starlite development updates January ’23
Mkdocs has the mkdocstrings plugin, offering limited automated API documentation capabilities. It is however nowhere near as capable as Sphinx' autodoc, missing granularity in its configuration, limited intersphinx-like cross-referencing support, and essential features like documentation of inherited members, or the ability to manually describe objects if needed.
-
what's a good documentation platform that you guys would recommend?
mkdocstrings works well, although it is not as powerful as the API documentation in Sphinx.
-
Stripe Open Sources Markdoc
Author of Materia for MkDocs here. MkDocstrings [1] implements automatic generation of reference documentation from sources. It's language-agnostic, actively maintained and currently supports Python [2] and Crystal [3]. It also integrates nicely with Material for MkDocs.
[1]: https://mkdocstrings.github.io/
- Mkdocstrings: Automatic Python documentation from sources, for MkDocs
- Technical documentation that just works
-
mkdocstrings: the "autodoc" plugin for MkDocs
Some time has passed since I first introduced mkdocstrings here on reddit. If you don't know what mkdocstrings is: it's the equivalent of the autodoc Sphinx extension, but for MkDocs, a Markdown static site generator. It works differently though, and supports multiple languages by design (not only Python). Someone actually wrote a very good handler for the Crystal language, and another user on GitHub recently expressed their interest for writing one for Go.
-
Python tutorials building large(r) projects
Write proper docstrings as you go along (every time you write a new class/method/function you can document what it’s doing as you’ll know why and what from the pattern you chose). Using a tool like mkdocstrings makes maintaining documentation for larger projects automatic.
-
[Project] mkgendocs - Generating documentation from Python docstrings for MkDocs
I learned of https://github.com/pawamoy/mkdocstrings recently. Is it similar ?
-
Python packages and plugins as namespace packages
A user of mkdocstrings wrote a Crystal handler for their own use-case. They asked on the Gitter channel if we could allow to load external handlers, so they don't have to fork the project and install the fork, but rather just install their lightweight package containing just the handler.
fastapi
-
Building an Email Assistant Application with Burr
In this tutorial, I will demonstrate how to use Burr, an open source framework (disclosure: I helped create it), using simple OpenAI client calls to GPT4, and FastAPI to create a custom email assistant agent. We’ll describe the challenge one faces and then how you can solve for them. For the application frontend we provide a reference implementation but won’t dive into details for it.
-
FastAPI Got Me an OpenAPI Spec Really... Fast
That’s when I found FastAPI.
-
How to Deploy a Fast API Application to a Kubernetes Cluster using Podman and Minikube
FastAPI & Uvicorn
-
Analysing FastAPI Middleware Performance
Discussion at FastAPI GitHub: https://github.com/tiangolo/fastapi/issues/2696
-
LangChain, Python, and Heroku
An API application framework (such as FastAPI)
-
Litestar – powerful, flexible, and highly performant Python ASGI framework
It’s been my experience that async Python frameworks tend to turn IO bound problems into CPU bound problems with a high enough request rate, because due to their nature they act as unbounded queues.
This ends up made worse if you’re using sync routes.
If you’re constrained on a resource such as a database connection pool, your framework will continue to pull http requests off the wire that a sane client will cancel and retry due to timeouts because it takes too long to get a connection out of the pool. Since there isn’t a straightforward way to cancel the execution of a route handler in every Python http framework I’ve seen exhibit this problem, the problem quickly snowballs.
This is an issue with fastapi, too- https://github.com/tiangolo/fastapi/issues/5759
-
AI-Powered Image Search with CLIP, pgvector, and Fast API
Fast API.
- Ask HN: What is your go-to stack for the web?
-
Fun with Avatars: Crafting the core engine | Part. 1
We will create our API using FastAPI, a modern high-performance web framework for building fast APIs with Python. It is designed to be easy to use, efficient, and highly scalable. Some key features of FastAPI include:
-
Building Fast APIs with FastAPI: A Comprehensive Guide
FastAPI is a modern, fast, web framework for building APIs with Python 3.7+ based on standard Python type hints. It is designed to be easy to use, fast to run, and secure. In this blog post, we’ll explore the key features of FastAPI and walk through the process of creating a simple API using this powerful framework.
What are some alternatives?
mkdocs-material - Documentation that simply works
AIOHTTP - Asynchronous HTTP client/server framework for asyncio and Python
sphinx - The Sphinx documentation generator
HS-Sanic - Async Python 3.6+ web server/framework | Build fast. Run fast. [Moved to: https://github.com/sanic-org/sanic]
pydocstyle - docstring style checker
Tornado - Tornado is a Python web framework and asynchronous networking library, originally developed at FriendFeed.
furo - A clean customizable documentation theme for Sphinx
django-ninja - 💨 Fast, Async-ready, Openapi, type hints based framework for building APIs
cookietemple - A collection of best practice cookiecutter templates for all domains and languages with extensive Github support ⛺
Flask - The Python micro framework for building web applications.
pydantic - Data validation using Python type hints
swagger-ui - Swagger UI is a collection of HTML, JavaScript, and CSS assets that dynamically generate beautiful documentation from a Swagger-compliant API.