Skip to content

Commit

Permalink
Updated Usage Section
Browse files Browse the repository at this point in the history
  • Loading branch information
DuckBoss authored Mar 18, 2018
1 parent 0f3bb31 commit f27180a
Showing 1 changed file with 16 additions and 11 deletions.
27 changes: 16 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,20 +15,25 @@ This is a script that accesses a subreddit and downloads images based on keyword
2) Keep the praw.ini file in the same directory as the python script.
3) Run the script with the following format that uses system arguments:
```
python ScannyMcScanFace.py <subreddit_name> <keyword_1> <keyword_2> ...
Format:
python ScannyMcScanFace.py subreddit_name "[keyword_1, keyword_2]" "(file_extension_1, file_extension_2)" -optional_params
Example Runs:
- Full run using keywords, file extensions, and optional parameters.
1) python ScannyMcScanFace.py all "[ducks, penguins]" "(.png, .jpg, .gif)" -stream
- Simple run using just the subreddit. This will capture all media with the default file extensions (png, jpg, gif).
2) python ScannyMcScanFace.py all
- Mixed run using just keywords, and no custom file extensions or parameters.
3) python ScannyMcScanFace.py all "[ducks, penguins]"
```
> You may choose to not include any keywords, which will capture all media available instead of submissions with keywords.
> You may choose to not include custom file extensions. This will cause the script to capture media with the default file extensions (png, gif, jpg).
> Optional parameters are not required to run the script. They are used to filter specific submissions.
## praw.ini file
You can use the template provided in this repository and fill in the required information as detailed in the usage section of the readme.

## All imports used
- praw
- wget
- urllib.request
- json
- os
- re
- datetime
- time
- sys
## All Optional Parameters
- -stream (enables real time capturing)
- -allow_nsfw (allows nsfw media to be captured)
- search_limit (format: -any_integer) (limits the number of submissions that are scanned)

0 comments on commit f27180a

Please sign in to comment.