Skip to main content

Official VideoHub Python SDK for building video, audio, and screen sharing applications.

Project description

VideoHub Python SDK

Official Python SDK for VideoHub – build video calls, audio rooms, and real-time communication applications with ease.

VideoHub enables developers to integrate video conferencing, audio rooms, real-time chat, AI chatbot integration, screen sharing, and real-time communication into their applications using simple APIs.


Installation

Install from PyPI:

pip install videohub-python

Requirements

  • Python 3.9+

  • Python 3.11+ (recommended)

  • VideoHub API Key

  • App credentials:

    • App ID
    • App Secret
    • App Platform (web, android, ios)
    • App Identifier (domain or package name)

Quick Start

from videohub.client import Client

client = Client(
    api_key="vhub_live_xxxxxxxxx",
    app_id="your_app_id",
    app_secret="your_app_secret",
    app_platform="web",
    app_identifier="example.com"
)

# Create a room
client.rooms.create(
    room_name="my-room",
    max_participants=5
)

# Generate a host token
token = client.rooms.host_token("my-room")

print(token)

Authentication

All API requests require the following credentials:

Field Description
API Key Account authentication key
App ID Unique application identifier
App Secret Secret used for request verification
App Platform web, android, or ios
App Identifier Domain or package name

Features

  • Video calling
  • Audio rooms
  • Screen sharing
  • Room management
  • Call management
  • Admin APIs
  • Secure authentication

Examples

Create Room

room = client.rooms.create(
    room_name="demo-room",
    max_participants=5
)

print(room)

Generate Room Token

token = client.rooms.host_token("demo-room")
print(token)

Error Handling

The SDK raises structured exceptions for API errors:

from videohub.exceptions import VideoHubError

try:
    client.rooms.create("room1")
except VideoHubError as e:
    print(e)

Project Structure

videohub/
├── client.py
├── config.py
├── constants.py
├── exceptions.py
├── http.py
│
├── services/
│   ├── auth.py
│   ├── rooms.py
│   ├── calls.py
│   └── admin.py
│
└── utils/
    └── validators.py

Documentation

Full API documentation is available at:

https://docs.videohub.dev


Contributing

Contributions are welcome.

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature-name)
  3. Commit your changes (git commit -m "Add feature")
  4. Push to the branch (git push origin feature-name)
  5. Open a Pull Request

Reporting Issues

If you encounter a bug or want to request a feature, please open an issue:

https://github.com/letscms/videohub-python/issues


License

This project is licensed under the MIT License.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

videohub_python-1.1.3.tar.gz (9.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

videohub_python-1.1.3-py3-none-any.whl (10.3 kB view details)

Uploaded Python 3

File details

Details for the file videohub_python-1.1.3.tar.gz.

File metadata

  • Download URL: videohub_python-1.1.3.tar.gz
  • Upload date:
  • Size: 9.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.2

File hashes

Hashes for videohub_python-1.1.3.tar.gz
Algorithm Hash digest
SHA256 fb9837dc1992fc90421dab956bd36f9ecdbdb7890d2b272ee15b76573732a94b
MD5 dadcde139d3786f462009889d731ad30
BLAKE2b-256 d4daa91fac5b1b2e6cfe90ea0c6d6a3fe49414e33e1983e41af1227e811a5a88

See more details on using hashes here.

File details

Details for the file videohub_python-1.1.3-py3-none-any.whl.

File metadata

File hashes

Hashes for videohub_python-1.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 3bbd40a33b9baff73b23ce321145bafe7b31c66f22ce33707ceef312c143f762
MD5 4eaaf6e0c69425cfa2360b4981cafd93
BLAKE2b-256 a31cbbe89e2531e0d770583056c6af01df514edd7db04545194451fc8b3e578d

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page