Created Installation (markdown)

Richard Mwewa
2023-02-11 06:18:59 +02:00
parent bb54f394f6
commit 4d01a41e6b

52
Installation.md Normal file

@@ -0,0 +1,52 @@
### Note
> The program has both a CLI and a GUI
## Installing the CLI
#### Note
> The cli is cross-platform and in order to use it, you will need to have Python installed on your system
### Install rom [PyPI](https://pypi.org/project/reddit-post-scraping-tool)
```
pip install reddit-post-scraping-tool
```
### Install the dev version from [GitHub](https://github.com/rly0nheart/reddit-post-scraping-tool)
#### Note
> The dev version might be unstable
```
pip install git+https://github.com/rly0nheart/reddit-post-scraping-tool
```
### Usage
```
reddit_post_scraping_tool --keyword [keyword] --subreddit [subreddit name (without 'r/')]
```
### Optional arguments
| Option | Argument | Choices | Usage |
| -------------|:-----------:|-----------:|:---------:|
| -l/--listing | LISTING | [controversial, hot, best, new, rising] | listing: controversial, hot, best, new, rising (default: top) |
| -c/--limit | NUMBER | 1-100 | results limit (default: 10)|
| -t/--timeframe| TIMEFRAME | [hour, day, week, month, year] | timeframe: hour, day, week, month, year (default: all) |
## Setting up the GUI
#### Note
> The GUI is only available for Windows systems
### Prerequisites
* **.NET 6.0 or later**
### 1. Download the GUI from the releases page
You can download the latest release of the gui from [here](https://github.com/bellingcat/octosuite/releases/latest)
### 2. Extract the downloaded `.zip`
![Screenshot_20230210_181651](https://user-images.githubusercontent.com/74001397/218141653-991a91cd-93d5-4640-b2f2-37d29e6a9c62.png)
### 3. Run the binary
Once extracted, you can then run the program by double clicking on a binary named `RPST.exe`
![Screenshot_20230210_181933](https://user-images.githubusercontent.com/74001397/218142422-70f19a0a-db39-42ee-8ad4-22fe380e249b.png)
![Screenshot_20230210_182210](https://user-images.githubusercontent.com/74001397/218142782-0a9ca4fb-7609-4855-a96b-c58885161166.png)