Skip to content

Commit 85c2b5e

Browse files
authored
Add info how to setup project (#15)
* Add info how to install * update * console * proto
1 parent 20ce0fe commit 85c2b5e

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,22 @@ asyncio.run(test_notifier())
8888
# Received a notification: ServerMessageRoomCreated(room_id='69a3fd1a-6a4d-47bc-ae54-0c72b0d05e29')
8989
```
9090

91+
## Local development
92+
93+
The project is managed using [poetry](https://python-poetry.org/). Make sure to have it installed first.
94+
95+
Then install the dependencies
96+
```console
97+
poetry install
98+
```
99+
100+
## Generating protobuf
101+
102+
To generate Python protobuf definitions run
103+
```console
104+
poetry run ./compile_proto.sh
105+
```
106+
91107
## Testing
92108

93109
You can test the SDK by running

0 commit comments

Comments
 (0)