Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rename Fishjam Cloud to Fishjam FCE-893 #18

Merged
merged 1 commit into from
Dec 9, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

# Fishjam Python Server SDK

Python server SDK for the [Fishjam Cloud](https://fishjam.io/).
Python server SDK for the [Fishjam](https://fishjam.io/).

Read the docs [here](https://fishjam-cloud.github.io/python-server-sdk)

Expand All @@ -29,7 +29,7 @@ from fishjam import FishjamClient
fishjam_client = FishjamClient(fishjam_url="localhost:5002", management_token="development")
```

You can use it to interact with Fishjam Cloud to manage rooms and peers
You can use it to interact with Fishjam to manage rooms and peers

```python
# Create a room
Expand Down Expand Up @@ -62,6 +62,7 @@ fishjam_notifier = FishjamNotifier(fishjam_url='localhost:5002', management_toke
```

Then define a handler for incoming messages

```python
@notifier.on_server_notification
def handle_notification(server_notification):
Expand Down Expand Up @@ -93,13 +94,15 @@ asyncio.run(test_notifier())
The project is managed using [poetry](https://python-poetry.org/). Make sure to have it installed first.

Then install the dependencies

```console
poetry install
```

## Generating protobuf

To generate Python protobuf definitions run

```console
poetry run ./compile_proto.sh
```
Expand Down Expand Up @@ -145,7 +148,7 @@ To update documentation you need to:

Licensed under the [Apache License, Version 2.0](LICENSE)

## Fishjam Cloud is created by Software Mansion
## Fishjam is created by Software Mansion

Since 2012 [Software Mansion](https://swmansion.com) is a software agency with experience in building web and mobile
apps. We are Core React Native Contributors and experts in dealing with all kinds of React Native issues. We can help
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[tool.poetry]
name = "fishjam-server-sdk"
version = "0.8.0"
description = "Python server SDK for the Fishjam Cloud"
description = "Python server SDK for the Fishjam"
authors = ["Fishjam Team"]
homepage = "https://github.com/fishjam-cloud/python-server-sdk"
documentation = "https://fishjam-cloud.github.io/python-server-sdk/fishjam"
Expand Down
Loading