bbbctl 0.3.1__tar.gz → 0.4__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (13) hide show
  1. {bbbctl-0.3.1/src/bbbctl.egg-info → bbbctl-0.4}/PKG-INFO +42 -25
  2. {bbbctl-0.3.1 → bbbctl-0.4}/README.md +33 -16
  3. bbbctl-0.4/pyproject.toml +28 -0
  4. bbbctl-0.4/src/bbbctl.py +897 -0
  5. bbbctl-0.3.1/PKG-INFO +0 -87
  6. bbbctl-0.3.1/pyproject.toml +0 -6
  7. bbbctl-0.3.1/setup.cfg +0 -31
  8. bbbctl-0.3.1/src/bbbctl.egg-info/SOURCES.txt +0 -10
  9. bbbctl-0.3.1/src/bbbctl.egg-info/dependency_links.txt +0 -1
  10. bbbctl-0.3.1/src/bbbctl.egg-info/entry_points.txt +0 -2
  11. bbbctl-0.3.1/src/bbbctl.egg-info/top_level.txt +0 -1
  12. bbbctl-0.3.1/src/bbbctl.py +0 -446
  13. {bbbctl-0.3.1 → bbbctl-0.4}/LICENSE +0 -0
{bbbctl-0.3.1/src/bbbctl.egg-info → bbbctl-0.4}/PKG-INFO RENAMED
@@ -1,46 +1,58 @@
1
- Metadata-Version: 2.2
1
+ Metadata-Version: 2.4
2
2
  Name: bbbctl
3
- Version: 0.3.1
3
+ Version: 0.4
4
4
  Summary: BigBlueButton API command-line client
5
- Home-page: https://github.com/defnull/bbbctl
6
- Author: Marcel Hellkamp
7
- Author-email: marc@gsites.de
8
- Project-URL: Bug Tracker, https://github.com/defnull/bbbctl/issues
9
- Classifier: Programming Language :: Python :: 3
10
- Classifier: License :: OSI Approved :: MIT License
11
- Classifier: Operating System :: OS Independent
5
+ Author-email: Marcel Hellkamp <marc@gsites.de>
12
6
  Requires-Python: >=3.6
13
7
  Description-Content-Type: text/markdown
8
+ License-Expression: MIT
9
+ Classifier: Programming Language :: Python :: 3
10
+ Classifier: Operating System :: OS Independent
14
11
  License-File: LICENSE
12
+ Project-URL: Bug Tracker, https://github.com/defnull/bbbctl/issues
13
+ Project-URL: Homepage, https://github.com/defnull/bbbctl
15
14
 
16
15
  # BigBlueButton REST API command-line client
17
16
 
18
- 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 directly access the backing BBB servers for administrative tasks, monitoring or testing.
17
+ This is a small but useful command-line client for controlling meetings and recordings on
18
+ a [BigBlueButton](https://docs.bigbluebutton.org/) server or cluster directly via the
19
+ [REST API](https://docs.bigbluebutton.org/dev/api.html). It allows administrators to bypass
20
+ front-end applications ([greenlight](https://github.com/bigbluebutton/greenlight),
21
+ [moodle](https://moodle.com/certified-integrations/bigbluebutton/) or alternatives) and
22
+ directly access the backing BBB servers for administrative tasks, monitoring or testing.
19
23
 
20
- 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.
24
+ The module can also be imported as a python library, but please note that this project is
25
+ not yet considered stable in any way. A stable and more usable API for python scripting
26
+ might follow.
21
27
 
22
28
  ## Install
23
29
 
30
+ You can install bbbctl the usual way with `pip install bbbctl` into a virtual environment.
31
+ Sine bbbctl has no dependencies, you can also **manually** install it by downloading the
32
+ python script and placing it into a bin folder:
33
+
24
34
  ```sh
25
- # Install via pip
26
- sudo pip install -U bbbctl
27
- # or manually:
28
- sudo curl -L https://raw.githubusercontent.com/defnull/bbbctl/master/src/bbbctl.py -o /usr/local/bin/bbbctl
29
- sudo chmod +x /usr/local/bin/bbbctl
35
+ curl -L --create-dirs -o ~/.local/bin/bbbctl https://raw.githubusercontent.com/defnull/bbbctl/master/src/bbbctl.py
36
+ chmod +x ~/.local/bin/bbbctl
30
37
  ```
31
38
 
39
+ **Tip:** If you have [uv/uvx](https://docs.astral.sh/uv/) installed, you can use this tool
40
+ directly via `uvx bbbctl ...`.
41
+
32
42
  ## Usage
33
43
 
44
+ If run directly on a BBB server with sufficient permissions, server URL and secret will
45
+ be fetched from local BBB config files automatically.
46
+
34
47
  ```sh
35
48
  # Only required for external BBB servers:
36
- export BBBCTL_SERVER="https://bbb.example.com/"
37
- export BBBCTL_SECRET="..."
49
+ export BBBCTL_SERVER="bbb.example.com" # or --server as a parameter
50
+ export BBBCTL_SECRET="..." # or --secret as a parameter
38
51
 
39
- bbbctl meeting list # Test your secret by listing current meetings
40
- bbbctl -h # Print help for a list of commands
41
- ```
52
+ # Check if your secret works:
53
+ bbbctl meeting list
42
54
 
43
- If run directly on a BBB server with sufficient permissions, server URL and secret will be fetched from local BBB config files automatically.
55
+ ```
44
56
 
45
57
  ## Command overview
46
58
 
@@ -52,21 +64,25 @@ You can get detailed help and a list of all parameters with `bbbctl -h` or `bbbc
52
64
  - `create <meetingID> <title>` Create a new meeting
53
65
  - `join <meetingID> <displayName>` Generate join links
54
66
  - `end <meetingID>` Forcefully end a meeting
67
+ - `chat <meetingID> <message>` Send a chat message to a running meeting (BBB 3.0)
55
68
  - `nuke` Forcefully end ALL meetings (be careful)
56
69
  - `record` Work with recordings
57
70
  - `list` List all recordings
58
71
  - `info <recordID>` Show info about a recording
59
72
  - `publish <recordID>` Publish an unpublished recording
60
- - `unpublish <recordID>` Unpublish (hide) recording)
73
+ - `unpublish <recordID>` Unpublish (hide) recording
61
74
  - `delete <recordID>` Delete a recording (be careful)
75
+ - `sign <action> <param*>` Print a signed API URL
62
76
 
63
77
  ## Output format
64
78
 
65
- The default output format is a human readable plain text format. You can switch to a more compact version with `--format=compact`. Other formats that are better suited for scripted usage are also supported: `json`, `jsonline` or `xml`
79
+ The default output format is a human readable plain text format. You can switch to a more
80
+ compact version with `--format=compact`. Other formats that are better suited for scripted
81
+ usage are also supported: `json`, `jsonline` or `xml`
66
82
 
67
83
  # License
68
84
 
69
- Copyright (c) 2020-2022, Marcel Hellkamp.
85
+ Copyright (c) 2020-2062, Marcel Hellkamp.
70
86
 
71
87
  Permission is hereby granted, free of charge, to any person obtaining a copy
72
88
  of this software and associated documentation files (the "Software"), to deal
@@ -85,3 +101,4 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
85
101
  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
86
102
  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
87
103
  THE SOFTWARE.
104
+
{bbbctl-0.3.1 → bbbctl-0.4}/README.md RENAMED
@@ -1,31 +1,44 @@
1
1
  # BigBlueButton REST API command-line client
2
2
 
3
- 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 directly access the backing BBB servers for administrative tasks, monitoring or testing.
3
+ This is a small but useful command-line client for controlling meetings and recordings on
4
+ a [BigBlueButton](https://docs.bigbluebutton.org/) server or cluster directly via the
5
+ [REST API](https://docs.bigbluebutton.org/dev/api.html). It allows administrators to bypass
6
+ front-end applications ([greenlight](https://github.com/bigbluebutton/greenlight),
7
+ [moodle](https://moodle.com/certified-integrations/bigbluebutton/) or alternatives) and
8
+ directly access the backing BBB servers for administrative tasks, monitoring or testing.
4
9
 
5
- 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.
10
+ The module can also be imported as a python library, but please note that this project is
11
+ not yet considered stable in any way. A stable and more usable API for python scripting
12
+ might follow.
6
13
 
7
14
  ## Install
8
15
 
16
+ You can install bbbctl the usual way with `pip install bbbctl` into a virtual environment.
17
+ Sine bbbctl has no dependencies, you can also **manually** install it by downloading the
18
+ python script and placing it into a bin folder:
19
+
9
20
  ```sh
10
- # Install via pip
11
- sudo pip install -U bbbctl
12
- # or manually:
13
- sudo curl -L https://raw.githubusercontent.com/defnull/bbbctl/master/src/bbbctl.py -o /usr/local/bin/bbbctl
14
- sudo chmod +x /usr/local/bin/bbbctl
21
+ curl -L --create-dirs -o ~/.local/bin/bbbctl https://raw.githubusercontent.com/defnull/bbbctl/master/src/bbbctl.py
22
+ chmod +x ~/.local/bin/bbbctl
15
23
  ```
16
24
 
25
+ **Tip:** If you have [uv/uvx](https://docs.astral.sh/uv/) installed, you can use this tool
26
+ directly via `uvx bbbctl ...`.
27
+
17
28
  ## Usage
18
29
 
30
+ If run directly on a BBB server with sufficient permissions, server URL and secret will
31
+ be fetched from local BBB config files automatically.
32
+
19
33
  ```sh
20
34
  # Only required for external BBB servers:
21
- export BBBCTL_SERVER="https://bbb.example.com/"
22
- export BBBCTL_SECRET="..."
35
+ export BBBCTL_SERVER="bbb.example.com" # or --server as a parameter
36
+ export BBBCTL_SECRET="..." # or --secret as a parameter
23
37
 
24
- bbbctl meeting list # Test your secret by listing current meetings
25
- bbbctl -h # Print help for a list of commands
26
- ```
38
+ # Check if your secret works:
39
+ bbbctl meeting list
27
40
 
28
- If run directly on a BBB server with sufficient permissions, server URL and secret will be fetched from local BBB config files automatically.
41
+ ```
29
42
 
30
43
  ## Command overview
31
44
 
@@ -37,21 +50,25 @@ You can get detailed help and a list of all parameters with `bbbctl -h` or `bbbc
37
50
  - `create <meetingID> <title>` Create a new meeting
38
51
  - `join <meetingID> <displayName>` Generate join links
39
52
  - `end <meetingID>` Forcefully end a meeting
53
+ - `chat <meetingID> <message>` Send a chat message to a running meeting (BBB 3.0)
40
54
  - `nuke` Forcefully end ALL meetings (be careful)
41
55
  - `record` Work with recordings
42
56
  - `list` List all recordings
43
57
  - `info <recordID>` Show info about a recording
44
58
  - `publish <recordID>` Publish an unpublished recording
45
- - `unpublish <recordID>` Unpublish (hide) recording)
59
+ - `unpublish <recordID>` Unpublish (hide) recording
46
60
  - `delete <recordID>` Delete a recording (be careful)
61
+ - `sign <action> <param*>` Print a signed API URL
47
62
 
48
63
  ## Output format
49
64
 
50
- The default output format is a human readable plain text format. You can switch to a more compact version with `--format=compact`. Other formats that are better suited for scripted usage are also supported: `json`, `jsonline` or `xml`
65
+ The default output format is a human readable plain text format. You can switch to a more
66
+ compact version with `--format=compact`. Other formats that are better suited for scripted
67
+ usage are also supported: `json`, `jsonline` or `xml`
51
68
 
52
69
  # License
53
70
 
54
- Copyright (c) 2020-2022, Marcel Hellkamp.
71
+ Copyright (c) 2020-2062, Marcel Hellkamp.
55
72
 
56
73
  Permission is hereby granted, free of charge, to any person obtaining a copy
57
74
  of this software and associated documentation files (the "Software"), to deal
bbbctl-0.4/pyproject.toml ADDED
@@ -0,0 +1,28 @@
1
+ [build-system]
2
+ requires = [
3
+ "flit_core>=3.12,<4",
4
+ ]
5
+ build-backend = "flit_core.buildapi"
6
+
7
+ [project]
8
+ name = "bbbctl"
9
+ version = "0.4"
10
+ description = "BigBlueButton API command-line client"
11
+ readme = "README.md"
12
+ requires-python = ">=3.6"
13
+ license = "MIT"
14
+ authors = [
15
+ { name = "Marcel Hellkamp", email = "marc@gsites.de" },
16
+ ]
17
+ classifiers = [
18
+ "Programming Language :: Python :: 3",
19
+ "Operating System :: OS Independent",
20
+ ]
21
+ dependencies = []
22
+
23
+ [project.urls]
24
+ Homepage = "https://github.com/defnull/bbbctl"
25
+ "Bug Tracker" = "https://github.com/defnull/bbbctl/issues"
26
+
27
+ [project.scripts]
28
+ bbbctl = "bbbctl:main"