Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/amoghmadan/openviduconnect
Wrapper to OpenVidu REST APIs
https://github.com/amoghmadan/openviduconnect
async package python sync
Last synced: 12 days ago
JSON representation
Wrapper to OpenVidu REST APIs
- Host: GitHub
- URL: https://github.com/amoghmadan/openviduconnect
- Owner: amoghmadan
- License: mit
- Created: 2021-05-21T18:35:15.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2021-05-26T10:46:33.000Z (over 3 years ago)
- Last Synced: 2024-11-17T19:36:03.331Z (2 months ago)
- Topics: async, package, python, sync
- Language: Python
- Homepage: https://pypi.org/project/openviduconnect/
- Size: 9.77 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# OpenVidu Connect
The project aims to connect to the OpenVidu Server.
It tries to wrap all the headers and APIs into attributes and methods of a class.
OpenVidu Connect provides support for Sync and Async API calls.
**(Enabled with context manager for both sync and async runs.)**
## What do we have in store?
- Future annotations are used to get the maximum output for support in IDEs
- Built on top of httpx (Get httpx: pip install httpx)
## Code Examples
- Sync Class (OpenViduClient) Example
```python
from openviduconnect import OpenViduClient
ov = OpenViduClient("", "")
response = ov.get_sessions()
print(response)
######
# OR #
######
with OpenViduClient("", "") as ov:
response = ov.get_sessions()
print(response)
```
- Async Class (AsyncOpenViduClient) Example
```python
from openviduconnect import AsyncOpenViduClient
aov = AsyncOpenViduClient("", "")
"""Async Stuff"""
response = await aov.get_sessions()
print(response)
######
# OR #
######
async with AsyncOpenViduClient("", "") as aov:
response = await aov.get_sessions()
print(response)
```
- We have all forms of specific errors respective to the documentation of the REST APIs
```python
from openviduconnect.exceptions import SessionBodyParameterError
"""SessionBodyParameterError is just an example there are many more"""
print(SessionBodyParameterError.status) # Provides HTTP Response Status Code
```
## Support
- Runs with Python 3.7 and beyond
- At this point it only supports OpenVidu 2.17.0
- Will try to maintain versions of openviduconnect for different OepnVidu versions
## Known issues?
- Documentation
- Others. *You tell me*