Skip to content

Commit

Permalink
updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Ryu1845 committed Oct 16, 2021
1 parent a0db552 commit 2373369
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 11 deletions.
10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ A python script to download twitter space.
## Downloads

[Linux](https://github.com/Ryu1845/twspace-dl/releases/latest/download/twspace_dl.bin)

[Windows](https://github.com/Ryu1845/twspace-dl/releases/latest/download/twspace_dl.exe)

## Usage
Expand All @@ -13,31 +14,32 @@ The script downloads from the beginning to the moment you started the script.

### Linux
```bash
./twspace_dl.bin -i space_url
./twspace_dl.bin -i space_url --wait 15
```

### Windows
```batch
.\twspace_dl.exe -i space_url
.\twspace_dl.exe -i space_url --wait 15
```

## Features
Here's the output of the help option
```
usage: main.py [-h] [-i SPACE_URL] [-f URL] [-t THREADS] [-v] [-m] [-w] [-u] [-s] [-k]
usage: main.py [-h] [-i SPACE_URL] [-w TIME] [-f URL] [-t THREADS] [-v] [-m] [-p] [-u] [-s] [-k]
Script designed to help download twitter spaces
optional arguments:
-h, --help show this help message and exit
-i SPACE_URL, --input-url SPACE_URL
-w TIME, --wait TIME Wait for a space to end to download it
-f URL, --from-master-url URL
use the master url for the processes(useful for ended spaces)
-t THREADS, --threads THREADS
number of threads to run the script with(default with max)
-v, --verbose
-m, --write-metadata write the full metadata json to a file
-w, --write-playlist write the m3u8 used to download the stream(e.g. if you want to use another downloader)
-p, --write-playlist write the m3u8 used to download the stream(e.g. if you want to use another downloader)
-u, --url display the master url
-s, --skip-download
-k, --keep-files
Expand Down
14 changes: 7 additions & 7 deletions twspace_dl/main.py
Original file line number Diff line number Diff line change
Expand Up @@ -207,6 +207,13 @@ def wait(self, time: int) -> None:
description="Script designed to help download twitter spaces"
)
parser.add_argument("-i", "--input-url", type=str, metavar="SPACE_URL")
parser.add_argument(
"-w",
"--wait",
type=int,
metavar="TIME",
help="Wait for a space to end to download it",
)
parser.add_argument(
"-f",
"--from-master-url",
Expand All @@ -223,13 +230,6 @@ def wait(self, time: int) -> None:
default=os.cpu_count(),
)
parser.add_argument("-v", "--verbose", action="store_true")
parser.add_argument(
"-w",
"--wait",
type=int,
metavar="TIME",
help="Wait for a space to end to download it(default with 15s)",
)
parser.add_argument(
"-m",
"--write-metadata",
Expand Down

0 comments on commit 2373369

Please sign in to comment.