bocadillo 0.13.1

A modern Python web framework filled with asynchronous salsa.

---

Documentation / CLI / Twitter / Blog / Mentions / FAQ

Bocadillo is a modern Python web framework that aims at making async web apps and services fun to build and accessible to everyone. We ultimately believe that web frameworks should be fun and easy to use while empowering the developer to make good decisions and ship high-quality applications.

It is designed to be:

• Productive: a carefully chosen set of included batteries* helps you solve common and more advanced problems.

• Real-time capable: embrace asynchronous programming and the baked-in WebSocket and SSE support to build real-time, highly-concurrent systems.

• Flexible: inject resources into web views using providers, an explicit, modular and easy-to-use mechanism inspired by pytest fixtures.

• Performant: squeeze the juice out of Starlette and uvicorn, the lightning-fast ASGI toolkit and web server.

• Empowering: use tailored testing and command line tools to build delicious, high-quality applications.

• Transparent: every single feature is documented front to back and has optimal editor support thanks to a 100% type-annotated code base.

*The bucket list: HTTP, WebSocket, SSE, CORS, HSTS, GZip, Jinja2 templates, dependency injection, background tasks, streaming, middleware, redirection, error handling, class-based views, view hooks, media responses, file responses, attachments, static files serving, test client, event handlers…

Quick start

We all love delicious "Hello, world!" examples, don't we? Here's ours:

1. Install Bocadillo:

pip install bocadillo

2. Write the app:

from bocadillo import App

app = App()

@app.route("/")
async def index(req, res):
    res.text = "Hello, world!"

if __name__ == "__main__":
    app.run()

3. Start the server:

python app.py

4. Say hello!

$ curl http://localhost:8000
Hello, world!

Tastes good! 🥪

Hungry for more? Head to the docs.

Changelog

Changes made to Bocadillo across releases are recorded in the Changelog. Be sure to check it out to see where we're coming from!

Roadmap

For a list of short, mid and long-term feature ideas currently in our scope, see the Roadmap.

To see what has already been implemented for the next release, see the Unreleased section of the changelog.

Contributing

Found a bug? A typo? Want to help build a new feature? We'd love to see your contributions! There are also many ways to contribute that don't include code: helping with issues, laying out new ideas, improving docs, etc.

Check out our Contributing guide for more information.

By the way, here's our Contributor Hall of Fame:

Credits

Logo designed by Florimond Manca. Sandwich icon designed by macrovector.