Skip to content
This repository has been archived by the owner on Mar 15, 2020. It is now read-only.
/ bocadillo Public archive

(UNMAINTAINED) Fast, scalable and real-time capable web APIs for everyone

License

Notifications You must be signed in to change notification settings

bocadilloproject/bocadillo

Repository files navigation

NOTICE

Bocadillo is now UNMAINTAINED. This repository should be archived soon. We recommend users to migrate to other well-supported alternatives, such as Starlette or FastAPI. Please see #334 for more information.


Build status Test coverage pypi version code style


Documentation: https://bocadilloproject.github.io


Bocadillo is a Python async web framework that makes building performant and highly concurrent web APIs fun and accessible to everyone.

Requirements

Python 3.6+

Installation

pip install bocadillo

Example

from bocadillo import App, configure

app = App()
configure(app)

@app.route("/")
async def index(req, res):
    res.json = {"hello": "world"}

Save this as app.py, then start a uvicorn server (hot reload enabled!):

uvicorn app:app --reload

Say hello!

$ curl http://localhost:8000
{"hello": "world"}

Ready to dive in? Visit the documentation site.

Changelog

All changes to Bocadillo are recorded in the changelog. To see what's coming in the next release, read the Unreleased section.

Release notes may also be published as blog posts on Bocadillo News.

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

By the way, here is the Bocadillo Contributor Hall of Fame. 👨‍💻👩‍💻

Credits

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