How to use Sanic: install and run a Python web app

What Sanic is and who it suits

Sanic is a Python framework for building web apps and API servers. Its design centres on asyncio, which lets a single process handle many requests at once.

It suits Python developers building web APIs or backend services, teams that want an asyncio-based Python web framework, and developers who prefer an ASGI-compatible stack.

• Good fit: Python web APIs and backend services
• Good fit: asyncio-based projects
• Not a fit: complete beginners without Python experience
• Not a fit: projects needing a full framework with built-in admin panels (the README provided no evidence of these)

Install Sanic with pip

Sanic is installed from PyPI. The only prerequisite named in the source is Python 3. Run the following command in your terminal, ideally inside a virtual environment.

Check your setup before writing code

Before building anything, confirm that Python 3 is available and that the pip install finished without errors. If the install fails, the most likely causes are an older Python interpreter or installing into a different environment than the one you are using.

• Confirm your Python version is 3
• Install into a virtual environment to keep dependencies separate
• Re-run pip install sanic if the first attempt errored

Understand the asyncio model

Sanic's core idea is asynchronous programming. Instead of blocking while waiting for a database or network call, a handler can yield control so the same process serves other requests. This is what the project means when it talks about running fast under load.

The supplied README was empty beyond project metadata, so this guide does not cite benchmarks. Test performance against your own workload before relying on it.

Where to find the full documentation

The project homepage is https://sanic.dev. Use it for routing, handlers and deployment details. This guide does not reproduce those APIs because the supplied source did not include them.