steffo/bbbdl
steffo/bbbdl
1
Fork 0
mirror of https://github.com/Steffo99/bbbdl.git synced 2024-11-22 07:44:18 +00:00
Code Activity

🗒 Create basic readme

Browse source
This commit is contained in:
Steffo 2020-10-26 18:14:14 +01:00
parent ccd1be4774
commit 9687b42c93
2 changed files with 42 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

42
README.md
View file

@ -2,8 +2,46 @@
A tool for downloading BigBlueButton meetings
## Requirements
- [`Python 3.8+`](https://www.python.org/)
- [`ffmpeg`](https://ffmpeg.org/download.html)
- [`pipx`](https://pipxproject.github.io/pipx/installation/)
## Installing
Run the following command:
```
pipx install bbbdl
```
## Usage
### Download a single BigBlueButton meeting
```
bbbdl download -i {MEETING_URL} -o {OUTPUT_FILE_NAME}
```
### Download all meetings from a list
```
bbbdl sync -j {LIST_FILE}
```
### Download all meetings from a remote list
```
bbbdl sync -r {LIST_FILE_URL}
```
## Meeting list format
A JSON file containing an object with filename/url pairs:
```json
{
"a.mp4": "https://example.org/playback/presentation/2.0/playback.html?meetingId=aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa-1111111111111",
"b.mp4": "https://example.org/playback/presentation/2.0/playback.html?meetingId=bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb-2222222222222"
}
```
pip install bbbdl
```

4
pyproject.toml
View file

@ -1,6 +1,6 @@
[tool.poetry]
name = "bbbdl"
version = "1.0.0"
version = "1.0.2"
description = "A downloader for BigBlueButton meetings"
authors = [
"Stefano Pigozzi <ste.pigozzi@gmail.com>",
@ -17,7 +17,7 @@ ffmpeg-python = "^0.2.0"
lxml = "^4.6.1"
[tool.poetry.scripts]
bbbdl = 'bbbdl.__main__:download'
bbbdl = 'bbbdl.__main__:main'
[build-system]
requires = ["poetry>=0.12"]