bocadillo 0.15.0

A modern Python web framework filled with asynchronous salsa.

Documentation · Source code · CLI

---

Migrating from v0.13.x? Read the v0.14 release notes.

Bocadillo is a Python async web framework that makes server-side async web apps fun to build and accessible to everyone.

It is designed to be:

• Productive: a carefully chosen set of included batteries helps you solve common and more advanced problems — request routing, app configuration, static files, data validation, and more!

• 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.

Quick start

1. Install Bocadillo and the Bocadillo CLI:

pip install bocadillo bocadillo-cli

2. Generate a project and cd into it:

bocadillo create hello
cd hello/

3. Edit the application script:

# hello/app.py
from bocadillo import App

app = App()

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

4. Start a uvicorn server (hot reload enabled!):

uvicorn hello.asgi:app --reload

5. Say hello!

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

6. Edit app.py to send "Hello, Bocadillo!" instead, then hit save. Uvicorn will pick up the changes and restart the application. Try it out again:

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

Tastes good! 🥪

Hungry for more? Head to the docs.

Changelog

We record changes to Bocadillo in the changelog. In particular, check out the Unreleased section to see what's coming in the next release.

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 to get started.

By the way, here's our Contributor Hall of Fame. 👨‍💻👩‍💻

Credits

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