Merge pull request #63 from aliparlakci/moreUsefulReadme
A more useful readme (credits to *stared*)
This commit is contained in:
Ali Parlakçı
GitHub
commit
0f2bda9c34
125
README.md
125
README.md
|
|
@ -1,9 +1,9 @@
|
|||
# Bulk Downloader for Reddit
|
||||
|
||||
Downloads media from reddit posts. Made by [u/aliparlakci](https://reddit.com/u/aliparlakci)
|
||||
|
||||
## [Download the latest release here](https://github.com/aliparlakci/bulk-downloader-for-reddit/releases/latest)
|
||||
|
||||
## What it can do
|
||||
|
||||
- Can get posts from: frontpage, subreddits, multireddits, redditor's submissions, upvoted and saved posts; search results or just plain reddit links
|
||||
- Sorts posts by hot, top, new and so on
|
||||
- Downloads **REDDIT** images and videos, **IMGUR** images and albums, **GFYCAT** links, **EROME** images and albums, **SELF POSTS** and any link to a **DIRECT IMAGE**
|
||||
|
|
@ -13,33 +13,124 @@ Downloads media from reddit posts. Made by [u/aliparlakci](https://reddit.com/u/
|
|||
- Saves a reusable copy of posts' details that are found so that they can be re-downloaded again
|
||||
- Logs failed ones in a file to so that you can try to download them later
|
||||
|
||||
## **Compiling it from source code**
|
||||
MacOS users have to use this option. See *[here](docs/COMPILE_FROM_SOURCE.md)*
|
||||
## Installation
|
||||
|
||||
## Additional options
|
||||
Script also accepts additional options via command-line arguments. Get further information from **[`--help`](docs/COMMAND_LINE_ARGUMENTS.md)**
|
||||
You can use it either as a `bulk-downloader-for-reddit.exe` executable file for Windows, as a Linux binary or as a *[Python script](#python-script)*. There is no MacOS executable, MacOS users must use the Python script option.
|
||||
|
||||
### Executables
|
||||
|
||||
For Windows and Linux, [download the latest release, here](https://github.com/aliparlakci/bulk-downloader-for-reddit/releases/latest).
|
||||
|
||||
### Python script
|
||||
|
||||
* Download this repository ([latest zip](https://github.com/aliparlakci/bulk-downloader-for-reddit/archive/master.zip) or `git clone git@github.com:aliparlakci/bulk-downloader-for-reddit.git`).
|
||||
* Enter its folder.
|
||||
* Run `python ./script.py` from the command-line (Windows, MacOSX or Linux command line; it may work with Anaconda prompt) See [here](docs/INTERPRET_FROM_SOURCE.md#finding-the-correct-keyword-for-python) if you have any trouble with this step.
|
||||
|
||||
It uses Python 3.6 and above. It won't work with Python 3.5 or any Python 2.x. If you have a trouble setting it up, see [here](docs/INTERPRET_FROM_SOURCE.md).
|
||||
|
||||
|
||||
### Setting up the script
|
||||
|
||||
## Setting up the script
|
||||
You need to create an imgur developer app in order API to work. Go to https://api.imgur.com/oauth2/addclient and fill the form (It does not really matter how you fill it).
|
||||
|
||||
|
||||
It should redirect you to a page where it shows your **imgur_client_id** and **imgur_client_secret**.
|
||||
|
||||
|
||||
When you run it for the first time, it will automatically create `config.json` file containing `imgur_client_id`, `imgur_client_secret`, `reddit_username` and `reddit_refresh_token`.
|
||||
|
||||
|
||||
## Running
|
||||
|
||||
You can run it it an interactive mode, or using [command-line arguments](docs/COMMAND_LINE_ARGUMENTS.md) (also available via `python ./script.py --help` or `bulk-downloader-for-reddit.exe --help`).
|
||||
|
||||
To run the interactive mode, simply use `python ./script.py` or double click on `bulk-downloader-for-reddit.exe` without any extra commands.
|
||||
|
||||
### [Example for command line arguemnts](docs/COMMAND_LINE_ARGUMENTS.md#examples)
|
||||
|
||||
### Example for an interactive script
|
||||
|
||||
```
|
||||
(py37) bulk-downloader-for-reddit user$ python ./script.py
|
||||
|
||||
Bulk Downloader for Reddit v1.6.5
|
||||
Written by Ali PARLAKCI – parlakciali@gmail.com
|
||||
|
||||
https://github.com/aliparlakci/bulk-downloader-for-reddit/
|
||||
|
||||
download directory: downloads/dataisbeautiful_last_few
|
||||
select program mode:
|
||||
|
||||
[1] search
|
||||
[2] subreddit
|
||||
[3] multireddit
|
||||
[4] submitted
|
||||
[5] upvoted
|
||||
[6] saved
|
||||
[7] log
|
||||
[0] exit
|
||||
|
||||
> 2
|
||||
(type frontpage for all subscribed subreddits,
|
||||
use plus to seperate multi subreddits: pics+funny+me_irl etc.)
|
||||
|
||||
subreddit: dataisbeautiful
|
||||
|
||||
select sort type:
|
||||
|
||||
[1] hot
|
||||
[2] top
|
||||
[3] new
|
||||
[4] rising
|
||||
[5] controversial
|
||||
[0] exit
|
||||
|
||||
> 1
|
||||
|
||||
limit (0 for none): 50
|
||||
|
||||
GETTING POSTS
|
||||
|
||||
|
||||
(1/24) – r/dataisbeautiful
|
||||
AutoModerator_[Battle]_DataViz_Battle_for_the_month_of_April_2019__Visualize_the_April_Fool's_Prank_for_2019-04-01_on__r_DataIsBeautiful_b8ws37.md
|
||||
Downloaded
|
||||
|
||||
(2/24) – r/dataisbeautiful
|
||||
AutoModerator_[Topic][Open]_Open_Discussion_Monday_—_Anybody_can_post_a_general_visualization_question_or_start_a_fresh_discussion!_bg1wej.md
|
||||
Downloaded
|
||||
|
||||
...
|
||||
|
||||
Total of 24 links downloaded!
|
||||
|
||||
Press enter to quit
|
||||
```
|
||||
|
||||
|
||||
## FAQ
|
||||
|
||||
### I am running the script on an headless machine or a remote server. How can I authenticate my reddit account?
|
||||
- Download the script on your everday computer and run it for once.
|
||||
- Authenticate the program on both reddit and imgur.
|
||||
- Go to your Home folder (for Windows users it is `C:\Users\[USERNAME]\`, for Linux users it is `/home/[USERNAME]`)
|
||||
- Copy the *config.json* file inside the Bulk Downloader for Reddit folder and paste it **next to** the file that you run the program.
|
||||
|
||||
### How can I change my credentials?
|
||||
- All of the user data is held in **config.json** file which is in a folder named "Bulk Downloader for Reddit" in your **Home** directory. You can edit
|
||||
them, there.
|
||||
- All of the user data is held in **config.json** file which is in a folder named "Bulk Downloader for Reddit" in your **Home** directory. You can edit them, there.
|
||||
|
||||
Also if you already have a config.json file, you can paste it **next to** the script and override the one on your Home directory.
|
||||
|
||||
### What do the dots resemble when getting posts?
|
||||
- Each dot means that 100 posts are scanned.
|
||||
|
||||
- Each dot means that 100 posts are scanned.
|
||||
|
||||
### Getting posts takes too long.
|
||||
- You can press *Ctrl+C* to interrupt it and start downloading.
|
||||
|
||||
|
||||
### How are the filenames formatted?
|
||||
- **Self posts** and **images** that do not belong to an album and **album folders** are formatted as:
|
||||
`[SUBMITTER NAME]_[POST TITLE]_[REDDIT ID]`
|
||||
You can use *reddit id* to go to post's reddit page by going to link reddit.com/[REDDIT ID]
|
||||
|
||||
|
||||
- An **image in an album** is formatted as:
|
||||
`[ITEM NUMBER]_[IMAGE TITLE]_[IMGUR ID]`
|
||||
Similarly, you can use *imgur id* to go to image's imgur page by going to link imgur.com/[IMGUR ID].
|
||||
|
|
@ -50,4 +141,6 @@ It should redirect you to a page where it shows your **imgur_client_id** and **i
|
|||
|
||||
However, they are basically text files. You can also view them with any text editor such as Notepad on Windows, gedit on Linux or Text Editor on MacOS
|
||||
|
||||
## [See the changes on *master* here](docs/CHANGELOG.md)
|
||||
## Changelog
|
||||
|
||||
* [See the changes on *master* here](docs/CHANGELOG.md)
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
# Using command-line arguments
|
||||
|
||||
See **[compiling from source](COMPILE_FROM_SOURCE.md)** page first unless you are using an executable file. If you are using an executable file, see [using terminal](COMPILE_FROM_SOURCE.md#using-terminal) and come back.
|
||||
See **[compiling from source](INTERPRET_FROM_SOURCE.md)** page first unless you are using an executable file. If you are using an executable file, see [using terminal](INTERPRET_FROM_SOURCE.md#using-terminal) and come back.
|
||||
|
||||
***Use*** `.\bulk-downloader-for-reddit.exe` ***or*** `./bulk-downloader-for-reddit` ***if you are using the executable***.
|
||||
```console
|
||||
|
|
@ -98,4 +98,4 @@ python script.py --directory C:\\NEW_FOLDER\\ANOTHER_FOLDER --log UNNAMED_FOLDER
|
|||
|
||||
# FAQ
|
||||
## I can't startup the script no matter what.
|
||||
See **[finding the correct keyword for Python](COMPILE_FROM_SOURCE.md#finding-the-correct-keyword-for-python)**
|
||||
See **[finding the correct keyword for Python](INTERPRET_FROM_SOURCE.md#finding-the-correct-keyword-for-python)**
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
# Compiling from source code
|
||||
# Interpret from source code
|
||||
## Requirements
|
||||
### Python 3 Interpreter
|
||||
- This program is designed to work best on **Python 3.6.5** and this version of Python 3 is suggested. See if it is already installed, [here](#finding-the-correct-keyword-for-python).
|
||||
|
|
@ -6,11 +6,11 @@
|
|||
|
||||
## Using terminal
|
||||
### To open it...
|
||||
- **On Windows**: Press **Shift+Right Click**, select **Open Powershell window here** or **Open Command Prompt window here**
|
||||
- **on Windows**: Press **Shift+Right Click**, select **Open Powershell window here** or **Open Command Prompt window here**
|
||||
|
||||
- **On Linux**: Right-click in a folder and select **Open Terminal** or press **Ctrl+Alt+T**.
|
||||
- **on Linux**: Right-click in a folder and select **Open Terminal** or press **Ctrl+Alt+T**.
|
||||
|
||||
- **On MacOS**: Look for an app called **Terminal**.
|
||||
- **on MacOS**: Look for an app called **Terminal**.
|
||||
|
||||
### Navigating to the directory where script is downloaded
|
||||
Go inside the folder where script.py is located. If you are not familiar with changing directories on command-prompt and terminal read *Changing Directories* in [this article](https://lifehacker.com/5633909/who-needs-a-mouse-learn-to-use-the-command-line-for-almost-anything)
|
||||
Loading…
Reference in a new issue