mirror of
https://github.com/Steffo99/bbbdl.git
synced 2024-11-21 15:24:19 +00:00
🗒 Update README
This commit is contained in:
parent
0655ce48f7
commit
f525ac3bc1
1 changed files with 3 additions and 50 deletions
53
README.md
53
README.md
|
@ -2,54 +2,7 @@
|
|||
|
||||
A tool for downloading BigBlueButton meetings
|
||||
|
||||
## Requirements
|
||||
## Documentation
|
||||
|
||||
- [`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"
|
||||
}
|
||||
```
|
||||
|
||||
### Development
|
||||
|
||||
1. Clone the git repository
|
||||
2. Install the dependencies with poetry:
|
||||
```bash
|
||||
poetry install
|
||||
```
|
||||
[To **install**, **use** and **contribute to** bbbdl, please refer to the documentation on readthedocs.io!](https
|
||||
://bbbdl.readthedocs.io/)
|
Loading…
Reference in a new issue