-
-# Robyn
-
-[](https://twitter.com/robyn_oss)
-[](https://pepy.tech/project/robyn)
-[](https://github.com/sansyrox/robyn/releases/)
-[](#license)
-
-
-[](https://sparckles.cloud/Robyn/#/)
-[](https://discord.gg/rkERZ5eNU8)
-
-Robyn is a fast async Python web framework coupled with a web server written in Rust. You can learn more by checking our [community resources](https://sparckles.cloud/Robyn/#/community-resources)!
-
-## π¦ Installation
-
-You can simply use Pip for installation.
-
-```
-pip install robyn
-```
-
-Or, with [conda-forge](https://conda-forge.org/)
-
-```
-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.
-
-```python
-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 -h
-
-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
-```
-
-Log level can be `DEBUG`, `INFO`, `WARNING`, or `ERROR`.
-
-### π» Add more routes
-
-You can add more routes to your API. Check out the routes in [this file](https://github.com/sansyrox/robyn/blob/main/integration_tests/base_routes.py) as examples.
-
-## π Python Version Support
-
-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
-
-```
-
-## π‘ 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](https://github.com/sansyrox/robyn/blob/main/CODE_OF_CONDUCT.md) and go through [CONTRIBUTING.md](https://github.com/sansyrox/robyn/blob/main/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](https://sparckles.cloud/Robyn/#/architecture).
-
-If you still need help to get started, feel free to reach out on our [community discord](https://discord.gg/rkERZ5eNU8).
-
-### βοΈ To Develop Locally
-
-1. Install the development dependencies: `poetry install --with dev --with test`
-
-2. Install the pre-commit git hooks: `pre-commit install`
-
-3. 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.
-
-4. Run `poetry run test_server`. This will run a server containing several examples of routes we use for testing purposes. You can see them at `integration_tests/base_routes.py`. You can modify or add some to your likings.
-
-You can then request the server you ran from an other terminal. Here is a `GET` request done using [curl](https://curl.se/) for example:
-```
-curl http://localhost:8080/sync/str
-```
-
-## β¨ Special thanks
-
-### β¨ Contributors/Supporters
-
-Thanks to all the contributors of the project. Robyn will not be what it is without all your support :heart:.
-
-
- from robyn import Robyn
-
-app = Robyn(__file__)
-
-@app.get("/")
-async def h(request):
- return "Hello, world!"
-
-app.start(port=8080)- Robyn is powered by these amazing people -
-
- 
-
- 
-
-