bbbctl 0.4__tar.gz → 0.4.2__tar.gz

{bbbctl-0.4 → bbbctl-0.4.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: bbbctl
-Version: 0.4
+Version: 0.4.2
 Summary: BigBlueButton API command-line client
 Author-email: Marcel Hellkamp <marc@gsites.de>
 Requires-Python: >=3.6
@@ -17,14 +17,10 @@ Project-URL: Homepage, https://github.com/defnull/bbbctl
 This is a small but useful command-line client for controlling meetings and recordings on
 a [BigBlueButton](https://docs.bigbluebutton.org/) server or cluster directly via the
 [REST API](https://docs.bigbluebutton.org/dev/api.html). It allows administrators to bypass
-front-end applications ([greenlight](https://github.com/bigbluebutton/greenlight),
-[moodle](https://moodle.com/certified-integrations/bigbluebutton/) or alternatives) and
+front-end applications (e.g. [greenlight](https://github.com/bigbluebutton/greenlight) or
+[moodle](https://moodle.com/certified-integrations/bigbluebutton/)) and
 directly access the backing BBB servers for administrative tasks, monitoring or testing.
 
-The module can also be imported as a python library, but please note that this project is
-not yet considered stable in any way. A stable and more usable API for python scripting
-might follow.
-
 ## Install
 
 You can install bbbctl the usual way with `pip install bbbctl` into a virtual environment.
@@ -51,7 +47,6 @@ export BBBCTL_SECRET="..."               # or --secret as a parameter
 
 # Check if your secret works:
 bbbctl meeting list
-
 ```
 
 ## Command overview
@@ -80,6 +75,21 @@ The default output format is a human readable plain text format. You can switch
 compact version with `--format=compact`. Other formats that are better suited for scripted
 usage are also supported: `json`, `jsonline` or `xml`
 
+## Use `BBBApiClient` from Python
+
+You can use the `BBBApiClient` class from Python, too. This thin wrapper around the
+BBB REST API can send signed API requests and return parsed XML `ElementTree`
+instances. Some convenience methods exist to get just the part of the XML you need.
+
+```python
+from bbbctl import BBBApiClient
+
+client = BBBApiClient(api="bbb.example.com", secret="***")
+
+for meeting in client.getMeetings():
+    print(meeting.findtext("./meetingID"), meeting.findtext("./meetingName"))
+```
+
 # License
 
 Copyright (c) 2020-2062, Marcel Hellkamp.

{bbbctl-0.4 → bbbctl-0.4.2}/README.md

@@ -3,14 +3,10 @@
 This is a small but useful command-line client for controlling meetings and recordings on
 a [BigBlueButton](https://docs.bigbluebutton.org/) server or cluster directly via the
 [REST API](https://docs.bigbluebutton.org/dev/api.html). It allows administrators to bypass
-front-end applications ([greenlight](https://github.com/bigbluebutton/greenlight),
-[moodle](https://moodle.com/certified-integrations/bigbluebutton/) or alternatives) and
+front-end applications (e.g. [greenlight](https://github.com/bigbluebutton/greenlight) or
+[moodle](https://moodle.com/certified-integrations/bigbluebutton/)) and
 directly access the backing BBB servers for administrative tasks, monitoring or testing.
 
-The module can also be imported as a python library, but please note that this project is
-not yet considered stable in any way. A stable and more usable API for python scripting
-might follow.
-
 ## Install
 
 You can install bbbctl the usual way with `pip install bbbctl` into a virtual environment.
@@ -37,7 +33,6 @@ export BBBCTL_SECRET="..."               # or --secret as a parameter
 
 # Check if your secret works:
 bbbctl meeting list
-
 ```
 
 ## Command overview
@@ -66,6 +61,21 @@ The default output format is a human readable plain text format. You can switch
 compact version with `--format=compact`. Other formats that are better suited for scripted
 usage are also supported: `json`, `jsonline` or `xml`
 
+## Use `BBBApiClient` from Python
+
+You can use the `BBBApiClient` class from Python, too. This thin wrapper around the
+BBB REST API can send signed API requests and return parsed XML `ElementTree`
+instances. Some convenience methods exist to get just the part of the XML you need.
+
+```python
+from bbbctl import BBBApiClient
+
+client = BBBApiClient(api="bbb.example.com", secret="***")
+
+for meeting in client.getMeetings():
+    print(meeting.findtext("./meetingID"), meeting.findtext("./meetingName"))
+```
+
 # License
 
 Copyright (c) 2020-2062, Marcel Hellkamp.

{bbbctl-0.4 → bbbctl-0.4.2}/pyproject.toml

@@ -6,7 +6,7 @@ build-backend = "flit_core.buildapi"
 
 [project]
 name = "bbbctl"
-version = "0.4"
+version = "0.4.2"
 description = "BigBlueButton API command-line client"
 readme = "README.md"
 requires-python = ">=3.6"

{bbbctl-0.4 → bbbctl-0.4.2}/src/bbbctl.py

@@ -335,10 +335,18 @@ class ApiError(RuntimeError):
 
 
 class BBBApiClient:
-    def __init__(self, api, secret, ssl_context=None):
+    def __init__(self, api, secret, ssl_context=None, debug=0):
+        # Add scheme if missing
+        if "://" not in api:
+            api = "https://" + api
+        # Add default API path, but only if there is no path yet
+        if api.count("/") == 2:
+            api += "/bigbluebutton/api"
+
         self.api = api.rstrip("/")
         self.secret = secret
         self.ssl = ssl_context or ssl.create_default_context()
+        self.debug = max(0, debug)
 
     def makeurl(self, command, **query):
         query = urllib.parse.urlencode(
@@ -354,14 +362,21 @@ class BBBApiClient:
 
     def call(self, command, **query):
         url = self.makeurl(command, **query)
+        if self.debug:
+            print(f">>> {url}", file=sys.stderr)
         with urllib.request.urlopen(url, context=self.ssl) as f:
             xml = f.read().decode("utf8")
+        if self.debug >= 2:
+            for line in xml:
+                print(f"<<< {line}", file=sys.stderr)
         root = ET.fromstring(xml)
         if (status := root.find("./returncode")) is None or status.text != "SUCCESS":
             raise ApiError(root)
         return root
 
-    def getJoinLink(self, **query):
+    def getJoinLink(self, meetingID, fullName, **query):
+        query["meetingID"] = meetingID
+        query["fullName"] = fullName
         return self.makeurl("join", **query)
 
     def getMeetings(self, **query):
@@ -370,13 +385,17 @@ class BBBApiClient:
     def getRecordings(self, **query):
         return self.call("getRecordings", **query).findall("./recordings/recording")
 
-    def getMeetingInfo(self, **query):
+    def getMeetingInfo(self, meetingID, **query):
+        query["meetingID"] = meetingID
         return self.call("getMeetingInfo", **query)
 
-    def createMeeting(self, **query):
+    def createMeeting(self, meetingID, name, **query):
+        query["meetingID"] = meetingID
+        query["name"] = name
         return self.call("create", **query)
 
-    def end(self, **query):
+    def end(self, meetingID, **query):
+        query["meetingID"] = meetingID
         return self.call("end", **query)
 
     def publishRecordings(self, recordID, publish):
@@ -418,6 +437,12 @@ def build_parser():
         help="Skip TLS verification and accept self-signed or expired SSL certificates",
         action="store_true",
     )
+    parser.add_argument(
+        "-v",
+        "--debug",
+        help="Print alls API calls. Repeat to also print all API responses.",
+        action="count",
+    )
 
     formats = ["human", "compact", "xml", "json", "jsonline"]
     parser.add_argument(
@@ -632,18 +657,12 @@ def main():
         )
     )
 
-    server = server.rstrip("/")
-    if "://" not in server:
-        server = "https://" + server
-    if not server.endswith("/bigbluebutton/api"):
-        server += "/bigbluebutton/api"
-
     ctx = ssl.create_default_context()
     if args.insecure:
         ctx.check_hostname = False
         ctx.verify_mode = ssl.CERT_NONE
 
-    client = BBBApiClient(server, secret, ssl_context=ctx)
+    client = BBBApiClient(server, secret, ssl_context=ctx, debug=args.debug)
 
     try:
         args.cmd(client, args)