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!
Source: TechEmpower Round 22
You can simply use Pip for installation.
pip install robyn
Or, with conda-forge
conda install -c conda-forge robyn
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)
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.
--version Show the Robyn version.
--compile-rust-path COMPILE_RUST_PATH
Compile rust files in the given path.
--create-rust-file CREATE_RUST_FILE
Create a rust file with the given name.
--disable-openapi Disable the OpenAPI documentation.
--fast Enable the fast mode.
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
You can add more routes to your API. Check out the routes in this file as examples.
Robyn is compatible with the following Python versions:
Python >= 3.8
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
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.
Before starting, ensure you have the following installed:
Clone the repository:
git clone https://github.com/sparckles/Robyn.git
Setup a virtual environment:
python3 -m venv .venv
source .venv/bin/activate
Install required packages
pip install pre-commit poetry maturin
Install development dependencies
poetry install --with dev --with test
Install pre-commit git hooks
pre-commit install
Build & install Robyn Rust package
maturin develop
Build & install Robyn Rust package (experimental)
maturin develop --cargo-extra-args="--features=io-uring"
Run!
poetry run test_server
Run all tests
pytest
Run only the integration tests
pytest integration_tests
Run only the unit tests (you don't need to be running the test_server for these)
pytest unit_tests
Test (refer to integration_tests/base_routes.py for more endpoints)
curl http://localhost:8080/sync/str
tip: One liners for testing changes!
maturin develop && poetry run test_server
maturin develop && pytest
tip: For IO-uring support, you can use the following command:
maturin develop --cargo-extra-args="--features=io-uring"
tip: To use your local Robyn version in other projects, you can install it using pip:
pip install -e path/to/robyn/target/wheels/robyn-<version>-<python_version>-<platform>.whl
e.g.
pip install -e /repos/Robyn/target/wheels/robyn-0.63.0-cp312-cp312-macosx_10_15_universal2.whl
If you face any issues, here are some common fixes:
patchelf with pip install patchelf if you face patchelf not found issue during maturin develop (esp. on Arch Linux)sudo apt install build-essentialsudo dnf install gccThanks to all the contributors of the project. Robyn will not be what it is without all your support :heart:.
Special thanks to the PyO3 community and Andrew from PyO3-asyncio for their amazing libraries and their support for my queries. 💖
These sponsors help us make the magic happen!
FAQs
A Super Fast Async Python Web Framework with a Rust runtime.
We found that robyn demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.
Security News
The Ultralytics' PyPI Package was compromised four times in one weekend through GitHub Actions cache poisoning and failure to rotate previously compromised API tokens.
