KevinMidboe/bulk-downloader-for-reddit
1
0
Fork 0
mirror of https://github.com/KevinMidboe/bulk-downloader-for-reddit.git synced 2025-10-29 17:40:15 +00:00
Code Issues Packages Projects Releases Wiki Activity

Readme refactor (#35)

Browse Source 
* Shorten the README.md file

* Added more information and guides

* Typo fix

* Rename sections
This commit is contained in:
aliparlakci
2018-07-12 12:25:09 +03:00
committed by GitHub
parent d2ed8327df
commit 795965f754
3 changed files with 70 additions and 39 deletions
Download Patch File Download Diff File Expand all files Collapse all files

39
docs/help_page.md → docs/COMMAND_LINE_ARGUMENTS.md
View File

@@ -1,6 +1,10 @@
## python script.py --help
# Using command-line arguments
See **[compiling from source](COMPILE_FROM_SOURCE.md)** page first unless you are using the .exe file. If you are using the .exe file, see [using terminal](COMPILE_FROM_SOURCE.md#using-terminal) and come back.
***Use*** `.\script.exe` ***if you are using the executable***.
```console
$ python script.py --help
usage: script.py [-h] [--directory DIRECTORY] [--link link] [--saved]
[--submitted] [--upvoted] [--log LOG FILE]
[--subreddit SUBREDDIT [SUBREDDIT ...]]
@@ -37,7 +41,7 @@ optional arguments:
downloading later
```
## Examples
# Examples
- **Use `python3` instead of `python` if you are using *MacOS* or *Linux***
@@ -46,40 +50,37 @@ python script.py
```
```console
python script.py .\\NEW_FOLDER --sort new --time all --limit 10 --link "https://www.reddit.com/r/gifs/search?q=dogs&restrict_sr=on&type=link&sort=new&t=month"
.\script.exe .\\NEW_FOLDER --search cats --sort new --time all --subreddit gifs pics --NoDownload
```
```console
python script.py .\\NEW_FOLDER --link "https://www.reddit.com/r/learnprogramming/comments/7mjw12/"
python script.py --directory .\\NEW_FOLDER --sort new --time all --limit 10 --link "https://www.reddit.com/r/gifs/search?q=dogs&restrict_sr=on&type=link&sort=new&t=month"
```
```console
python script.py .\\NEW_FOLDER --search cats --sort new --time all --subreddit gifs pics --NoDownload
python script.py --directory .\\NEW_FOLDER --link "https://www.reddit.com/r/learnprogramming/comments/7mjw12/"
```
```console
python script.py .\\NEW_FOLDER --user [USER_NAME] --submitted --limit 10
python script.py --directory .\\NEW_FOLDER --search cats --sort new --time all --subreddit gifs pics --NoDownload
```
```console
python script.py .\\NEW_FOLDER --multireddit good_subs --user [USER_NAME] --sort top --time week --limit 250
python script.py --directory .\\NEW_FOLDER --user [USER_NAME] --submitted --limit 10
```
```console
python script.py .\\NEW_FOLDER\\ANOTHER_FOLDER --saved --limit 1000
python script.py --directory .\\NEW_FOLDER --multireddit good_subs --user [USER_NAME] --sort top --time week --limit 250
```
```console
python script.py C:\\NEW_FOLDER\\ANOTHER_FOLDER --log UNNAMED_FOLDER\\FAILED.json
python script.py --directory .\\NEW_FOLDER\\ANOTHER_FOLDER --saved --limit 1000
```
## FAQ
### I can't startup the script no matter what.
- Try these:
- **`python`**
- **`python3`**
- **`python3.7`**
- **`python3.6`**
- **`py -3`**
Python have real issues about naming their program
```console
python script.py --directory C:\\NEW_FOLDER\\ANOTHER_FOLDER --log UNNAMED_FOLDER\\FAILED.json
```
# FAQ
## I can't startup the script no matter what.
See **[finding the correct prefix for Python](COMPILE_FROM_SOURCE.md#finding-the-correct-prefix-for-python)**

31
docs/COMPILE_FROM_SOURCE.md Normal file
View File

@@ -0,0 +1,31 @@
# Compiling from source code
## Requirements
### Python 3 Interpreter
Latest* version of **Python 3** is needed. Download the matching release for your platform [here](https://www.python.org/downloads/) and install it. If you are a *Windows* user, selecting **Add Python 3 to PATH** option is mandatory.
\* *Use Python 3.6.5 if you encounter an issue*
## Using terminal
### To open it...
- On Windows 8/8.1/10: Press the File tab on **Windows Explorer**, click on **Open Windows PowerShell** or **Open Windows Command Prompt** or look for *Command Prompt* or *PowerShell* in *Start Menu*.
- On Windows 7: Press **WindowsKey+R**, type **cmd** and hit Enter or look for *Command Prompt* or *PowerShell* in *Start Menu*.
- On Linux: Press **Ctrl+Alt+T** or look for **Terminal** in the programs.
- 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 familier 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)
## Finding the correct prefix for Python
Enter these lines to terminal windows until it prints out the version you have downloaded and installed:
- `python --version`
- `python3 --version`
- `python3.7 --version`
- `python3.6 --version`
- `py --version`
- `py -3 --version`
- `py -3.6 --version`
- `py -3.7 --version`
Once you find it, use it at [Using command-line arguments](COMMAND_LINE_ARGUMENTS.md)