Skip to content

Latest commit

 

History

History
95 lines (59 loc) · 3.07 KB

README.md

File metadata and controls

95 lines (59 loc) · 3.07 KB

Robyn Logo

Robyn

sansyrox Gitter Downloads Code style: black GitHub tag License

view - Documentation

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

Python server running on top of of Rust Async RunTime.

📦 Installation

You can simply use Pip for installation.

pip 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!
  • Hot Reloading (Still experimental)
  • 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. Add more routes in the integration_tests/base_routes.py file(if you like).

  2. Run maturin develop

  3. 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

✨ 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. 💖