https://github.com/rsocket/rsocket-py
RSocket implementation in Python
https://github.com/rsocket/rsocket-py
Last synced: 10 months ago
JSON representation
RSocket implementation in Python
- Host: GitHub
- URL: https://github.com/rsocket/rsocket-py
- Owner: rsocket
- License: mit
- Created: 2016-12-19T17:34:59.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2025-05-12T02:21:03.000Z (10 months ago)
- Last Synced: 2025-05-14T07:17:11.618Z (10 months ago)
- Language: Python
- Homepage:
- Size: 1.64 MB
- Stars: 77
- Watchers: 11
- Forks: 23
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.rst
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# RSocket-py
Python implementation of [RSocket](http://rsocket.io)
# Installation
The latest version from [pypi](https://pypi.org/project/rsocket/) can be installed using:
```shell
pip install rsocket
```
You may also install using some **extras**:
| Extra | Functionality | Documentation |
|-----------------|--------------------------------------------------------------------------------------------|---------------------------------------------------------------------|
| rx | ReactiveX ([v3](https://pypi.org/project/Rx/)) integration | [Tutorial](https://rsocket.io/guides/rsocket-py/tutorial/reactivex) |
| reactivex | [ReactiveX](https://reactivex.io/) ([v4](https://pypi.org/project/reactivex/)) integration | [Tutorial](https://rsocket.io/guides/rsocket-py/tutorial/reactivex) |
| aiohttp | [aiohttp](https://docs.aiohttp.org/en/stable/) Websocket transport (server/client) | [Tutorial](https://rsocket.io/guides/rsocket-py/tutorial/websocket) |
| fastapi | [fastapi](https://github.com/fastapi/fastapi) Websocket transport (server/client) | |
| channels | Websocket transport (server only) using channels (django) | |
| quart | [Quart](https://pgjones.gitlab.io/quart/) Websocket transport (server only) | |
| quic | [QUIC](https://github.com/aiortc/aioquic) transport | |
| websockets | [Websockets](https://github.com/python-websockets/websockets) transport (server only) | |
| asyncwebsockets | [Websockets](https://github.com/Fuyukai/asyncwebsockets) transport (client only) | |
| cli | Command line | [Tutorial](https://rsocket.io/guides/rsocket-py/cli) |
| optimized | Frame parse/serialize optimizations | |
| cloudevents | [CloudEvents](https://cloudevents.io/) integration | |
| graphql | [GraphQL](https://graphql.org/) integration | [Tutorial](https://rsocket.io/guides/rsocket-py/graphql) |
For example:
```shell
pip install rsocket[reactivex]
```
Alternatively, download the source code, build a package:
```shell
python3 setup.py bdist_wheel
```
Use the resulting package from the **./dist** folder, or install locally:
```shell
python3 setup.py install
```
# Documentation
[Documentation](https://rsocket.io/guides/rsocket-py) is available on the official rsocket.io site.
[API](https://rsocket.readthedocs.io/en/latest/index.html) documentation is at readthedocs.io.
# Examples
Examples can be found in the **/examples** folder. It contains various server and client usages. The following is a
table
denoting which client example is constructed to be run against which server example. Some examples
are in java to show compatibility with a different implementation. To run the java examples first build using mvn
package.
The **examples/test_examples.py** can be used to execute the relevant example server/client pairs.
client_springboot.py is set up to work against
the [Spring RSocket demo](https://github.com/benwilcock/spring-rsocket-demo).
| server (python) | server (java) | client (python) | client(java) |
|-----------------------------|-------------------------|------------------------------------|-----------------|
| server.py | | client.py | |
| server_quic.py | | client_quic.py | |
| server_with_lease.py | | | ClientWithLease |
| server_with_routing.py | | client_with_routing.py | Client |
| server_with_routing.py | | client_rx.py | |
| server_with_routing.py | | client_reconnect.py | |
| | Server | run_against_example_java_server.py | |
| | ServerWithFragmentation | client_with_routing.py | |
| server_quart_websocket.py | | client_websocket.py | |
| server_aiohttp_websocket.py | | client_websocket.py | |
| server_fastapi_websocket.py | | client_websocket.py | |
| server_graphql.py | ServerWithGraphQL | client_graphql.py | |
# Build Status
[](https://coveralls.io/github/rsocket/rsocket-py?branch=master)
[](https://github.com/rsocket/rsocket-py/actions/workflows/codeql-analysis.yml)
# Progress
- [X] Requests
- [X] Fire and forget
- [X] Response
- [X] Stream
- [X] Channel
- [X] Metadata push
- [ ] Features
- [X] Keepalive / Max server life
- [X] Lease
- [ ] Resume
- [X] Fragmentation
- [X] Extensions
- [X] Composite metadata
- [X] Per Stream Mimetype
- [X] Routing
- [X] Authentication
- [ ] Transports
- [X] TCP
- [X] Websocket (WS, WSS) - Quart and aiohttp integration
- [X] QUIC
- [X] HTTP/3
- [ ] HTTP/2
- [ ] Aeron
- [X] RxPy Integration
- [X] Stream Response
- [X] Channel Response
- [X] Channel Requester stream
- [X] Response
- [X] Other
- [X] Reconnect
- [X] Load balancing
- [X] Server routing definition helper (Flask like syntax)
- [X] Reactivex integration (v3, v4) server/client side
- [X] Command line interface