sage_bbb

Table of Contents

• sage_bbb
  • Table of Contents
  • Introduction
  • Features
  • Installation
    • Using pip
    • Using Poetry
  • Usage
    • Verifying Installation
    • Creating a Meeting
  • Package Structure
  • Contributing
  • 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:

   python -m venv .venv

2. Activate the Virtual Environment:

   • On Windows:

     .venv\Scripts\activate

   • On macOS and Linux:

     source .venv/bin/activate

3. Install the Package:

   pip install python-sage-bbb

Using Poetry

1. Install Poetry: Follow the official installation instructions at the Poetry website.

2. Create a New Project (Optional):

   poetry new myproject
   cd myproject

3. Add the Package as a Dependency:

   poetry add python-sage-bbb

4. Activate the Virtual Environment:

   poetry shell

Usage

Verifying Installation

To verify the installation, run a simple script to import the package:

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:

   from sage_bbb.services.client import BigBlueButtonClient

2. Initialize the client:

   bbb_client = BigBlueButtonClient(
       "http://your-bbb-server.com/bigbluebutton/api/",
       "your-security-salt",
   )

3. Check the connection:

   connection_status = bbb_client.check_connection()
   print(f"Connection Status: {connection_status}")

4. Create a new meeting:

   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:

   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:

   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 file for guidelines.

License

This project is licensed under the MIT License - see the 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.