| Name | python-sage-bbb JSON |
| Version |
0.1.3
JSON |
| download |
| home_page | None |
| Summary | A Python client library for interacting with BigBlueButton API, enabling the creation and management of online meetings, recordings, and configurations. |
| upload_time | 2024-12-14 18:13:28 |
| maintainer | None |
| docs_url | None |
| author | MohmdFo |
| requires_python | <4.0,>=3.10 |
| license | MIT |
| keywords |
python
meet
bigbluebutton
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# sage_bbb
## Table of Contents
- [sage\_bbb](#sage_bbb)
- [Table of Contents](#table-of-contents)
- [Introduction](#introduction)
- [Features](#features)
- [Installation](#installation)
- [Using pip](#using-pip)
- [Using Poetry](#using-poetry)
- [Usage](#usage)
- [Verifying Installation](#verifying-installation)
- [Creating a Meeting](#creating-a-meeting)
- [Package Structure](#package-structure)
- [Contributing](#contributing)
- [License](#license)
## Introduction
`sage_bbb` is a Python package designed to simplify interaction with the BigBlueButton (BBB) API. BigBlueButton is an open-source web conferencing system ideal for virtual classrooms, online meetings, and remote collaboration.
## Features
- **Meeting Management**: Create, join, end, and retrieve meeting information.
- **Recording Management**: Access, publish, unpublish, and delete recordings.
- **Configuration Management**: Customize the BigBlueButton environment.
- **URL Validation and Checksum Generation**: Ensure secure API requests.
## Installation
### Using pip
1. **Create a Virtual Environment**:
```bash
python -m venv .venv
```
2. **Activate the Virtual Environment**:
- On Windows:
```bash
.venv\Scripts\activate
```
- On macOS and Linux:
```bash
source .venv/bin/activate
```
3. **Install the Package**:
```bash
pip install python-sage-bbb
```
### Using Poetry
1. **Install Poetry**: Follow the official installation instructions at the [Poetry website](https://python-poetry.org/docs/#installation).
2. **Create a New Project (Optional)**:
```bash
poetry new myproject
cd myproject
```
3. **Add the Package as a Dependency**:
```bash
poetry add python-sage-bbb
```
4. **Activate the Virtual Environment**:
```bash
poetry shell
```
## Usage
### Verifying Installation
To verify the installation, run a simple script to import the package:
```python
from sage_bbb.services.client import BigBlueButtonClient
# Initialize the client
bbb_client = BigBlueButtonClient(
"https://your-bbb-server.com/bigbluebutton/api/",
"your-security-salt",
)
# Check connection
connection_status = bbb_client.check_connection()
print(f"Connection Status: {connection_status}")
```
### Creating a Meeting
1. **Import the necessary modules**:
```python
from sage_bbb.services.client import BigBlueButtonClient
```
2. **Initialize the client**:
```python
bbb_client = BigBlueButtonClient(
"http://your-bbb-server.com/bigbluebutton/api/",
"your-security-salt",
)
```
3. **Check the connection**:
```python
connection_status = bbb_client.check_connection()
print(f"Connection Status: {connection_status}")
```
4. **Create a new meeting**:
```python
new_meeting = bbb_client.meetings.create_meeting(
name="Test Meeting",
meeting_id="random-9887584",
attendee_pw="ap",
moderator_pw="mp",
record=True, # Enable recording
autoStartRecording=True,
allowStartStopRecording=True
)
print(f"New Meeting: {new_meeting}")
```
5. **Join the meeting as a moderator**:
```python
join_url_moderator = bbb_client.meetings.join_meeting(
meeting_id="random-9887584",
full_name="Moderator",
password="mp"
)
print(f"Join URL (Moderator): {join_url_moderator}")
```
6. **Join the meeting as an attendee**:
```python
join_url_attendee = bbb_client.meetings.join_meeting(
meeting_id="random-9887584",
full_name="Attendee",
password="ap"
)
print(f"Join URL (Attendee): {join_url_attendee}")
```
## Package Structure
- **helpers**: Contains the `Meeting` dataclass for managing meeting-related data.
- **services**: Includes modules for client, configurations, factory, meetings, and recordings.
- **utils**: Provides utility classes for URL validation and checksum generation.
## Contributing
Contributions are welcome! Please refer to the [CONTRIBUTING.md](CONTRIBUTING.md) file for guidelines.
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
---
Enhance your virtual collaboration experiences with `sage_bbb` by integrating BigBlueButton’s powerful features into your own applications and automating routine tasks.
Raw data
{
"_id": null,
"home_page": null,
"name": "python-sage-bbb",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.10",
"maintainer_email": null,
"keywords": "python, meet, BigBlueButton",
"author": "MohmdFo",
"author_email": "mohammad.fotouhi80@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/4c/21/13c828efdfcd82575ec8261e26094e28c9048d526d37a397159ce7a60095/python_sage_bbb-0.1.3.tar.gz",
"platform": null,
"description": "# sage_bbb\n\n\n\n## Table of Contents\n- [sage\\_bbb](#sage_bbb)\n - [Table of Contents](#table-of-contents)\n - [Introduction](#introduction)\n - [Features](#features)\n - [Installation](#installation)\n - [Using pip](#using-pip)\n - [Using Poetry](#using-poetry)\n - [Usage](#usage)\n - [Verifying Installation](#verifying-installation)\n - [Creating a Meeting](#creating-a-meeting)\n - [Package Structure](#package-structure)\n - [Contributing](#contributing)\n - [License](#license)\n\n## Introduction\n`sage_bbb` is a Python package designed to simplify interaction with the BigBlueButton (BBB) API. BigBlueButton is an open-source web conferencing system ideal for virtual classrooms, online meetings, and remote collaboration.\n\n## Features\n- **Meeting Management**: Create, join, end, and retrieve meeting information.\n- **Recording Management**: Access, publish, unpublish, and delete recordings.\n- **Configuration Management**: Customize the BigBlueButton environment.\n- **URL Validation and Checksum Generation**: Ensure secure API requests.\n\n## Installation\n\n### Using pip\n\n1. **Create a Virtual Environment**:\n ```bash\n python -m venv .venv\n ```\n\n2. **Activate the Virtual Environment**:\n - On Windows:\n ```bash\n .venv\\Scripts\\activate\n ```\n - On macOS and Linux:\n ```bash\n source .venv/bin/activate\n ```\n\n3. **Install the Package**:\n ```bash\n pip install python-sage-bbb\n ```\n\n### Using Poetry\n\n1. **Install Poetry**: Follow the official installation instructions at the [Poetry website](https://python-poetry.org/docs/#installation).\n\n2. **Create a New Project (Optional)**:\n ```bash\n poetry new myproject\n cd myproject\n ```\n\n3. **Add the Package as a Dependency**:\n ```bash\n poetry add python-sage-bbb\n ```\n\n4. **Activate the Virtual Environment**:\n ```bash\n poetry shell\n ```\n\n## Usage\n\n### Verifying Installation\n\nTo verify the installation, run a simple script to import the package:\n\n```python\nfrom sage_bbb.services.client import BigBlueButtonClient\n\n# Initialize the client\nbbb_client = BigBlueButtonClient(\n \"https://your-bbb-server.com/bigbluebutton/api/\",\n \"your-security-salt\",\n)\n\n# Check connection\nconnection_status = bbb_client.check_connection()\nprint(f\"Connection Status: {connection_status}\")\n```\n\n### Creating a Meeting\n\n1. **Import the necessary modules**:\n ```python\n from sage_bbb.services.client import BigBlueButtonClient\n ```\n\n2. **Initialize the client**:\n ```python\n bbb_client = BigBlueButtonClient(\n \"http://your-bbb-server.com/bigbluebutton/api/\",\n \"your-security-salt\",\n )\n ```\n\n3. **Check the connection**:\n ```python\n connection_status = bbb_client.check_connection()\n print(f\"Connection Status: {connection_status}\")\n ```\n\n4. **Create a new meeting**:\n ```python\n new_meeting = bbb_client.meetings.create_meeting(\n name=\"Test Meeting\",\n meeting_id=\"random-9887584\",\n attendee_pw=\"ap\",\n moderator_pw=\"mp\",\n record=True, # Enable recording\n autoStartRecording=True,\n allowStartStopRecording=True\n )\n print(f\"New Meeting: {new_meeting}\")\n ```\n\n5. **Join the meeting as a moderator**:\n ```python\n join_url_moderator = bbb_client.meetings.join_meeting(\n meeting_id=\"random-9887584\",\n full_name=\"Moderator\",\n password=\"mp\"\n )\n print(f\"Join URL (Moderator): {join_url_moderator}\")\n ```\n\n6. **Join the meeting as an attendee**:\n ```python\n join_url_attendee = bbb_client.meetings.join_meeting(\n meeting_id=\"random-9887584\",\n full_name=\"Attendee\",\n password=\"ap\"\n )\n print(f\"Join URL (Attendee): {join_url_attendee}\")\n ```\n\n## Package Structure\n\n- **helpers**: Contains the `Meeting` dataclass for managing meeting-related data.\n- **services**: Includes modules for client, configurations, factory, meetings, and recordings.\n- **utils**: Provides utility classes for URL validation and checksum generation.\n\n## Contributing\n\nContributions are welcome! Please refer to the [CONTRIBUTING.md](CONTRIBUTING.md) file for guidelines.\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n\n---\n\nEnhance your virtual collaboration experiences with `sage_bbb` by integrating BigBlueButton\u2019s powerful features into your own applications and automating routine tasks.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A Python client library for interacting with BigBlueButton API, enabling the creation and management of online meetings, recordings, and configurations.",
"version": "0.1.3",
"project_urls": null,
"split_keywords": [
"python",
" meet",
" bigbluebutton"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4c6a670340dea6a61c019767dde65f86ad7d6c527ef9d30c035600f6cc885a99",
"md5": "af6c649d219f425c905075821b7d3fab",
"sha256": "3f6519114fe0e42258d040503c87e90ab219875d8ee43274a41910a9475aa58a"
},
"downloads": -1,
"filename": "python_sage_bbb-0.1.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "af6c649d219f425c905075821b7d3fab",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.10",
"size": 12595,
"upload_time": "2024-12-14T18:13:18",
"upload_time_iso_8601": "2024-12-14T18:13:18.930191Z",
"url": "https://files.pythonhosted.org/packages/4c/6a/670340dea6a61c019767dde65f86ad7d6c527ef9d30c035600f6cc885a99/python_sage_bbb-0.1.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "4c2113c828efdfcd82575ec8261e26094e28c9048d526d37a397159ce7a60095",
"md5": "a552b23677c709adb7d9aebc9e4146dc",
"sha256": "b31c677e4f404375e53179162247f372fceb5cc18882dd137435c05d3f090464"
},
"downloads": -1,
"filename": "python_sage_bbb-0.1.3.tar.gz",
"has_sig": false,
"md5_digest": "a552b23677c709adb7d9aebc9e4146dc",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.10",
"size": 11717,
"upload_time": "2024-12-14T18:13:28",
"upload_time_iso_8601": "2024-12-14T18:13:28.799680Z",
"url": "https://files.pythonhosted.org/packages/4c/21/13c828efdfcd82575ec8261e26094e28c9048d526d37a397159ce7a60095/python_sage_bbb-0.1.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-14 18:13:28",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "python-sage-bbb"
}
