Skip to main content

Python API for BigBlueButton.

Project description

BigBlueButton Python API

The work of this project is forked from https://hg.sr.ht/~dreimark/bigbluebutton-python-api which in turn is derived from https://github.com/schallis/django-bigbluebutton 98f2259fa3 by Steve Challis.

It is a wrapper for accessing the API of BigBlueButton https://docs.bigbluebutton.org/dev/api.html

Installation

pip install bigbluebutton-api

Usage

Here are a few things you can do with this library.

from bigbluebutton import BigBlueButton
bbb = BigBlueButton('<YOUR_BBB_URL>', '<YOUR_BBB_SALT>')
meeting_id = 'some-meeting-id'
bbb.create_meeting(meeting_id, 'Some meeting name', 'attendee password', 'moderator password')

moderator_link = meeting.join_meeting_url(meeting_id, 'Example Moderator', 'moderator password'))
attendee_link = meeting.join_meeting_url(meeting_id, 'Example Attendee', 'attendee password'))

all_meetings = meeting.get_meetings()
is_running = meeting.is_running(meeting_id)
end_link = meeting.end_meeting_url(meeting_id, 'moderator password')

if meeting.is_running(meeting_id):
    meeting.end_meeting(meeting_id, 'moderator password')

Disclaimer

I have absolutely no experience with publishing packages to PyPI and with copyright / attributions. I don't intend to step on anyone's toes, I just felt like the original library needed a few bugfixes and improvements.

If you feel I haven't recognized your work on this project, please let me know.

I don't plan on further maintaining this package, unless the BBB API changes enough to break it. We do use this in production, however I can't guarantee everything works (we mainly use the create and join calls). I can, however, review any PRs and accept new contributors (after a few approved PRs).

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

bigbluebutton-api-0.8.2.tar.gz (7.3 kB view details)

Uploaded Source

Built Distribution

bigbluebutton_api-0.8.2-py3-none-any.whl (8.0 kB view details)

Uploaded Python 3

File details

Details for the file bigbluebutton-api-0.8.2.tar.gz.

File metadata

  • Download URL: bigbluebutton-api-0.8.2.tar.gz
  • Upload date:
  • Size: 7.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.8.5

File hashes

Hashes for bigbluebutton-api-0.8.2.tar.gz
Algorithm Hash digest
SHA256 b302c006adf7aa6e4a894c2db19ee9c013c040f5d1d8ae9dbb4e257e9ff40991
MD5 b2acd9cde3580f80d71e8c5afd4a3d6b
BLAKE2b-256 ecdd6d1112f3985f2b8d2566b0e48411e22279c691dc4e10f104df6a02c1d60c

See more details on using hashes here.

File details

Details for the file bigbluebutton_api-0.8.2-py3-none-any.whl.

File metadata

  • Download URL: bigbluebutton_api-0.8.2-py3-none-any.whl
  • Upload date:
  • Size: 8.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.8.5

File hashes

Hashes for bigbluebutton_api-0.8.2-py3-none-any.whl
Algorithm Hash digest
SHA256 b40dd826ec94e6df686e9ddb2d3341450d916056a8fb2d34d8d83dac7e88ddc6
MD5 527b8797f0f9a8751904deefa35c62c6
BLAKE2b-256 dba62442a012d57d92167a45a08c652e1608c3189b14996b0e0bac9ded997d2d

See more details on using hashes here.

Supported by

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