Commit dbff7fd2 authored by David Huss's avatar David Huss 💬
Browse files

Add Readme and release to pypi

parent 9257a3e7
# bbbmon
A small python based CLI utility to monitor BigBlueButton-Usage.
## Installation
The easiest way to install bbbmon is to install it from the Python Package Index (PyPi). This project uses [python poetry]( for dependency management, so you could also run it without installing the package system wide, see instructions below.
## Install with pip3
sudo pip3 install bbbmon --upgrade
Then run with:
## Run with poetry (without pip)
Clone the repo:
git clone
Make sure you have poetry installed. Install instruction for poetry can be [found here](
From inside the project directory run:
poetry install
Run bbbmon with:
poetry run bbbmon
For bbbmon to run you need to have a `` file at the path specified. In this file there should be your servers secret and the server URL. You can find this secret on your server in the file `/usr/share/bbb-web/WEB-INF/classes/` (look for a line starting with `securitySalt=` and copy it to). If in doubt just follow the instructions the CLI gives you.
......@@ -299,7 +299,4 @@ def init_variables() -> Optional[Tuple[Secret, Url]]:
def main():
secret, bbb_url = init_variables()
print_overview(secret, bbb_url)
if __name__ == "__main__":
\ No newline at end of file
print_overview(secret, bbb_url)
\ No newline at end of file
name = "bbbmon"
version = "0.1.0"
version = "0.1.5"
description = "A small CLI utility to monitor bbb usage"
authors = ["David Huss <>"]
license = "MIT"
maintainers = ["David Huss <>"]
license = "GPLv3"
readme = ""
classifiers = [
"Development Status :: 3 - Alpha",
"Environment :: Console",
"Intended Audience :: System Administrators",
"License :: Free for non-commercial use",
"License :: Free For Educational Use",
"License :: OSI Approved :: GNU General Public License v3 (GPLv3)",
"Natural Language :: English",
"Programming Language :: Python :: 3.6",
"Topic :: System :: Monitoring",
"Topic :: Communications :: Conferencing"
python = "^3.5"
......@@ -14,8 +28,7 @@ appdirs = "^1.4.3"
pytest = "^5.2"
# bbbmon = { path = "" }
run = "bbbmon.bbbmon:main"
bbbmon = "bbbmon.bbbmon:main"
requires = ["poetry>=0.12"]
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment