touilleMan / robyn

Robyn is a fast and extensible async python web server with a rust runtime

Home Page:https://robyn.tech/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Robyn Logo

Robyn

sansyrox Twitter Gitter Downloads Code style: black GitHub tag License

view - Documentation

Robyn is an async Python backend server with a runtime written in Rust, btw.

Check out the talk at PyCon Sweden 2021 about Robyn: An async python web framework with a Rust runtime

📦 Installation

You can simply use Pip for installation.

pip install robyn

Or, with conda-forge

conda config --add channels conda-forge
conda config --set channel_priority strict
conda install robyn

🤔 Usage

from robyn import Robyn

app = Robyn(__file__)

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

app.start(port=5000)

💡 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!

🗒️ Contributor Guidelines

Feel free to open an issue for any clarification or for any suggestions.

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

⚙️ To Develop Locally

  1. Install the development dependencies: pip install -r dev-requirements.txt

  2. Install the pre-commit git hooks: pre-commit install

  3. Add more routes in the integration_tests/base_routes.py file(if you like).

  4. Run maturin develop or maturin develop --cargo-extra-args="--features=io-uring" (if you want to run the experimental version).

  5. Run python3 integration_tests/base_routes.py

🏃 To Run

python3 app.py -h

usage: app.py [-h] [--processes PROCESSES] [--workers WORKERS] [--dev DEV]

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

optional arguments:
  -h, --help            show this help message and exit
  --processes PROCESSES : allows you to choose the number of parallel processes
  --workers WORKERS : allows you to choose the number of workers
  --dev DEV : this flag gives the option to enable hot reloading or not and also sets the default log level to debug
  --log-level LEVEL : this flag allows you to set the log level

Contributors/Supporters

To contribute to Robyn, make sure to first go through the CONTRIBUTING.md.

Thanks to all the contributors of the project. Robyn will not be what it is without all your support ❤️.

Special thanks to the PyO3 community and Andrew from PyO3-asyncio for their amazing libraries and their support for my queries. 💖

Sponsors

These sponsors help us make the magic happen!

DigitalOcean Referral Badge

About

Robyn is a fast and extensible async python web server with a rust runtime

https://robyn.tech/

License:BSD 2-Clause "Simplified" License


Languages

Language:Rust 57.3%Language:Python 42.0%Language:HTML 0.8%