Skip to content

Commit

Permalink
updated docs and extras
Browse files Browse the repository at this point in the history
  • Loading branch information
@jell-o-fishi
jell-o-fishi committed Oct 20, 2023
1 parent a02035b commit 5262d37
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 14 deletions.
25 changes: 13 additions & 12 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,18 +12,19 @@ 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) |
| 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) | |
| 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) |
| 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) |
| 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:

Expand Down
4 changes: 2 additions & 2 deletions setup.cfg
View file
Original file line number Diff line number Diff line change
Expand Up @@ -61,8 +61,8 @@ cloudevents =
graphql =
graphql-core>=3.2.0
gql>=3.4.0
websockets =
websockets>=11.0.0
websockets = websockets>=11.0.0
asyncwebsockets = asyncwebsockets>=0.9.4

[options.entry_points]
cli.console_scripts =
Expand Down

0 comments on commit 5262d37

Please sign in to comment.