Skip to content

Commit a18685c

Browse files
committed
added --progress-bar in README
1 parent d03cf1d commit a18685c

File tree

1 file changed

+32
-3
lines changed

1 file changed

+32
-3
lines changed

README.md

Lines changed: 32 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -110,6 +110,8 @@ bdfr archive ./path/to/output --user reddituser --submitted --all-comments --com
110110
bdfr archive ./path/to/output --subreddit all --format yaml -L 500 --folder-scheme ""
111111
```
112112

113+
### YAML options
114+
113115
Alternatively, you can pass options through a YAML file.
114116

115117
```bash
@@ -128,16 +130,40 @@ subreddit:
128130
- CityPorn
129131
```
130132
131-
would be equilavent to (take note that in YAML there is `file_scheme` instead of `file-scheme`):
133+
would be equivalent to:
132134
133135
```bash
134136
bdfr download ./path/to/output --skip mp4 --skip avi --file-scheme "{UPVOTES}_{REDDITOR}_{POSTID}_{DATE}" -L 10 -S top --subreddit EarthPorn --subreddit CityPorn
135137
```
136138

137139
Any option that can be specified multiple times should be formatted like subreddit is above.
140+
In case when the same option is specified both in the YAML file and as a command line argument, the command line
141+
argument takes priority.
142+
143+
### Progress bar
138144

139-
In case when the same option is specified both in the YAML file and in as a command line argument, the command line
140-
argument takes priority
145+
When you run BDFR manually from your Terminal, if you pass `--progress-bar`,
146+
you will get a progress bar with a live summary of the results.
147+
Each downloaded image comes with its status (❌ or ✅),
148+
the number of upvotes, and title. For example:
149+
150+
```bash
151+
python -m bdfr download ./example -S top -L 50 -s DataIsBeautiful --progress-bar
152+
```
153+
154+
```text
155+
✅ 162712🔼 [OC] Trending Google Searches by State Between 2018 and 2020
156+
✅ 122725🔼 I analysed 70 years of baby names in the US to decide what t...
157+
✅ 120972🔼 For everyone asking why i didn't include the Spanish Flu and...
158+
✅ 111357🔼 Let's hear it for the lurkers! The vast majority of Reddit u...
159+
❌ 109991🔼 US College Tuition & Fees vs. Overall Inflation [OC]
160+
✅ 106921🔼 A wish for election night data visualization [OC]
161+
✅ 104746🔼 [OC] u/IHateTheLetterF is a mad lad
162+
✅ 104517🔼 Area of land burnt in Australia and area of smoke coverage s...
163+
✅ 101616🔼 Light Speed – fast, but slow [OC]
164+
Subreddits: 0%| | 0/2 [00:39<?, ?subreddit/s]
165+
dataisbeautiful/top: 18%|███▊ | 9/50 [00:39<01:56, 2.84s/post]
166+
```
141167

142168
## Options
143169

@@ -176,6 +202,9 @@ The following options are common between both the `archive` and `download` comma
176202
- `--log`
177203
- This allows one to specify the location of the logfile
178204
- This must be done when running multiple instances of the BDFR, see [Multiple Instances](#multiple-instances) below
205+
- `--progress-bar`
206+
- Displays a progress bar in the terminal
207+
- Prints a simplified log for each downloaded image (status, upvotes, title)
179208
- `--saved`
180209
- This option will make the BDFR use the supplied user's saved posts list as a download source
181210
- This requires an authenticated Reddit instance, using the `--authenticate` flag, as well as `--user` set to `me`

0 commit comments

Comments
 (0)