Robyn

Robyn is a High-Performance, Community-Driven, and Innovator Friendly Web Framework with a Rust runtime. You can learn more by checking our community resources!

📦 Installation

You can simply use Pip for installation.

pip install robyn

Or, with conda-forge

conda install -c conda-forge robyn

🤔 Usage

🚀 Define your API

To define your API, you can add the following code in an app.py file.

from robyn import Robyn

app = Robyn(__file__)

@app.get("/")
async def h(request):
    return "Hello, world!"

app.start(port=8080)

🏃 Run your code

Simply run the app.py file you created. You will then have access to a server on the localhost:8080, that you can request from an other program. Robyn provides several options to customize your web server.

$ python3 app.py

To see the usage

usage: app.py [-h] [--processes PROCESSES] [--workers WORKERS] [--dev] [--log-level LOG_LEVEL]

Robyn, a fast async web framework with a rust runtime.

options:
  -h, --help                show this help message and exit
  --processes PROCESSES     Choose the number of processes. [Default: 1]
  --workers WORKERS         Choose the number of workers. [Default: 1]
  --dev                     Development mode. It restarts the server based on file changes.
  --log-level LOG_LEVEL     Set the log level name
  --create                  Create a new project template.
  --docs                    Open the Robyn documentation.
  --open-browser            Open the browser on successful start.

Log level can be DEBUG, INFO, WARNING, or ERROR.

When running the app using --open-browser a new browser window will open at the app location, e.g:

$ python3 app.py --open-browser

💻 Add more routes

You can add more routes to your API. Check out the routes in this file as examples.

🐍 Python Version Support

Robyn is compatible with the following Python versions:

Python >= 3.7

It is recommended to use the latest version of Python for the best performances.

Please make sure you have the correct version of Python installed before starting to use this project. You can check your Python version by running the following command in your terminal:

python --version

💡 Features

Under active development!
Written in Rust, btw xD
A multithreaded Runtime
Extensible
A simple API
Sync and Async Function Support
Dynamic URL Routing
Multi Core Scaling
WebSockets!
Middlewares
Hot Reloading
Community First and truly FOSS!

🗒️ How to contribute

🏁 Get started

Please read the code of conduct and go through CONTRIBUTING.md before contributing to Robyn. Feel free to open an issue for any clarifications or suggestions.

If you're feeling curious. You can take a look at a more detailed architecture here.

If you still need help to get started, feel free to reach out on our community discord.

⚙️ To Develop Locally

Install the development dependencies (preferably inside a virtual environment): pip install -r dev-requirements.txt
Install the pre-commit git hooks: pre-commit install
Run maturin develop or maturin develop --cargo-extra-args="--features=io-uring" for using the experimental version of actix-web. This command will build the Robyn Rust package and install it in your virtual environment.
Run python3 integration_tests/base_routes.py. This file contains several examples of routes we use for testing purposes. You can modify or add some to your likings.