@@ -19,7 +19,7 @@ The SDK exports two main classes for interacting with Fishjam server:
1919
2020` FishjamClient ` wraps http REST api calls, while ` FishjamNotifier ` is responsible for receiving real-time updates from the server.
2121
22- #### FishjamClient
22+ ### FishjamClient
2323
2424Create a ` FishjamClient ` instance, providing the fishjam server address and api token
2525
@@ -46,7 +46,7 @@ peer, token = fishjam_client.create_peer(room.id)
4646
4747All methods in ` FishjamClient ` may raise one of the exceptions deriving from ` fishjam.errors.HTTPError ` . They are defined in ` fishjam.errors ` .
4848
49- #### FishjamNotifier
49+ ### FishjamNotifier
5050
5151FishjamNotifier allows for receiving real-time updates from the Fishjam Server.
5252
@@ -89,62 +89,6 @@ asyncio.run(test_notifier())
8989# Received a notification: ServerMessageRoomCreated(room_id='69a3fd1a-6a4d-47bc-ae54-0c72b0d05e29')
9090```
9191
92- ## Local development
93-
94- The project is managed using [ uv] ( https://docs.astral.sh/uv/ ) . Make sure to have it installed first.
95-
96- Then install the dependencies
97-
98- ``` console
99- uv sync --all-packages
100- ```
101-
102- ## Generating protobuf
103-
104- To generate Python protobuf definitions run
105-
106- ``` console
107- uv run ./compile_proto.sh
108- ```
109-
110- ## Testing
111-
112- You can test the SDK by running
113-
114- ``` console
115- uv run ci_test
116- ```
117-
118- In local development you can use
119-
120- ``` console
121- uv run local_test
122- ```
123-
124- ## Format & Lint
125-
126- You can format code by running
127-
128- ``` console
129- uv run format
130- ```
131-
132- You can check linter by running
133-
134- ``` console
135- uv run lint
136- ```
137-
138- ## Documentation
139-
140- Documentation is generated via openapi-python-client.
141-
142- To update documentation you need to:
143-
144- - Go to https://github.com/fishjam-cloud/fishjam/blob/main/openapi.yaml and open the raw file.
145- - Copy the URL.
146- - Run ` uv run update_client <copied-url> `
147-
14892## License
14993
15094Licensed under the [ Apache License, Version 2.0] ( LICENSE )
0 commit comments