diff --git a/README.md b/README.md index b9622e0..18185f4 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ -socketify.py brings: +## 💡 Features - WebSocket with pub/sub support - Fast and realiable Http/Https @@ -21,7 +21,7 @@ socketify.py brings: - Support for [`PyPy3`](https://www.pypy.org/) and [`CPython`](https://github.com/python/cpython) -This project aims to bring high performance PyPy3 web development and will bring: +## :mag_right: Upcoming Features - Fetch like API powered by libuv - Async file IO powered by libuv - Full asyncio integration with libuv @@ -32,19 +32,7 @@ We created and adapt the full C API from [uNetworking/uWebSockets](https://githu **socketify is experimental software at the moment, but quickly heading towards its first release**. Join Github Discussions for help and have a look at things that don’t work yet. -## socketify.py vs japronto - -People really want to compare with japronto, but this projects are not really comparable. Socketify is an active project and will be maintained over time with security updates and new features, japronto don't get any github updates since 2020 and don't get any src update since 2018, japronto don't support SSL, WebSockets, [`PyPy3`](https://www.pypy.org/), Windows or macOS Silicon, socketify will support Http3 and a lot more features. - -And yes, we can be faster than japronto when all our features and goals are achieved, and we are probably faster than any current maintained solution out there. - -## uvloop -We don't use uvloop, because uvloop don't support Windows and PyPy3 at this moment, this can change in the future, but right now we want to implement our own libuv + asyncio solution, and a lot more. - -## CFFI vs Cython vs HPy -Cython performs really well on Python3 but really bad on PyPy3, CFFI are choosen for better support PyPy3 until we got our hands on an stable [`HPy`](https://hpyproject.org/) integration. - -## Benchmarks +## :zap: Benchmarks HTTP requests per second (Linux x64) ![image](https://raw.githubusercontent.com/cirospaciari/socketify.py/main/misc/bench-bar-graph.svg) @@ -66,7 +54,7 @@ Machine OS: Debian GNU/Linux bookworm/sid x86_64 Kernel: 6.0.0-2-amd64 CPU: Inte > Today socketify have about 30% performance hit due to workarounds between asyncio + libuv, so we will got even faster! See more info in [this issue](https://github.com/cirospaciari/socketify.py/issues/18), Python3 and PyPy3 performance will improve when we migrate to [HPy](https://github.com/cirospaciari/socketify.py/issues/16). In TechEmPower benchmarks we are faster than japronto in plaintext (about 1,300k req/s using PyPy3 without workaround and about 770k req/s with the current state vs 582k from japronto you can follow details in [this discussion](https://github.com/cirospaciari/socketify.py/discussions/10) -## Install +## 📦 Install For macOS x64 & Silicon, Linux x64, Windows ```bash @@ -87,7 +75,7 @@ pip install -r ./requirements.txt pypy3 -m pip install -r ./requirements.txt ``` -## Examples +## 🤔 Examples Hello world app ```python @@ -138,7 +126,7 @@ app.run() We have more than 20 examples [click here](https://github.com/cirospaciari/socketify.py/tree/main/examples) for more -## Build local from source +## :hammer: Build local from source ```bash #clone and update submodules git clone https://github.com/cirospaciari/socketify.py.git @@ -154,21 +142,33 @@ pypy3 -m pip install -e . pypy3 -m pip uninstall socketify ``` -## Commercially supported +## :briefcase: Commercially supported I'm a Brazilian consulting & contracting company dealing with anything related with [socketify.py](https://github.com/cirospaciari/socketify.py) and [socketify.rb](https://github.com/cirospaciari/socketify.rb) Don't hesitate sending a mail if you are in need of advice, support, or having other business inquiries in mind. We'll figure out what's best for both parties. Special thank's to [uNetworking AB](https://github.com/uNetworking) to develop [uWebSockets](https://github.com/uNetworking/uWebSockets), [uSockets](https://github.com/uNetworking/uSockets) and allow us to bring this features and performance to Python and PyPy -## Sponsors +## :heart: Sponsors If you like to see this project thrive, you can sponsor us on GitHub too. We need all the help we can get -## Stargazers +## :star: Stargazers [![Stargazers repo roster for @cirospaciari/socketify.py](https://reporoster.com/stars/dark/cirospaciari/socketify.py)](https://github.com/cirospaciari/socketify.py/stargazers) -## Forkers +## :wrench: Forkers [![Forkers repo roster for @cirospaciari/socketify.py](https://reporoster.com/forks/dark/cirospaciari/socketify.py)](https://github.com/cirospaciari/socketify.py/network/members) + +## :question: socketify.py vs japronto + +People really want to compare with japronto, but this projects are not really comparable. Socketify is an active project and will be maintained over time with security updates and new features, japronto don't get any github updates since 2020 and don't get any src update since 2018, japronto don't support SSL, WebSockets, [`PyPy3`](https://www.pypy.org/), Windows or macOS Silicon, socketify will support Http3 and a lot more features. + +And yes, we can be faster than japronto when all our features and goals are achieved, and we are probably faster than any current maintained solution out there. + +## :grey_question: uvloop +We don't use uvloop, because uvloop don't support Windows and PyPy3 at this moment, this can change in the future, but right now we want to implement our own libuv + asyncio solution, and a lot more. + +## :dizzy: CFFI vs Cython vs HPy +Cython performs really well on Python3 but really bad on PyPy3, CFFI are choosen for better support PyPy3 until we got our hands on an stable [`HPy`](https://hpyproject.org/) integration.