bellingcat/reddit-post-scraping-tool
1
0
Fork 0
mirror of https://github.com/bellingcat/reddit-post-scraping-tool.git synced 2026-06-08 03:28:30 +03:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Richard Mwewa
2023-02-11 06:45:32 +02:00
committed by GitHub
parent 85eb59d87d
commit c4c7999fe0
1 changed files with 15 additions and 47 deletions
Download Patch File Download Diff File Expand all files Collapse all files

62
README.md
View File

@@ -5,56 +5,24 @@ Given a subreddit name and a keyword, this script will return all posts from a s
![Screenshot_20230210_193329](https://user-images.githubusercontent.com/74001397/218158084-9295abb7-df33-4f86-8df8-e109cac7cde6.png)
# Features
- [x] Auto dark mode from 6pm - 6am
- [x] Saves results to a JSON
- [x] Other features coming soon...
# Installation
### 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
```
# TODO
- [x] Make it a stand alone executable
- [x] Add comments to the code 😆
### 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
```
# Wiki
[Refer to the Wiki](https://github.com/bellingcat/reddit-post-scraping-tool/wiki) for installation instructions, in addition to all other documentation.
### Usage
# Note
> This is one of the projects I am working on, while learning Visual Basic, so the implementation/code may be messed up. If that's the case, please feel free to open a pull request using the available templates. Otherwise, enjoy!
```
reddit_post_scraping_tool --keyword [keyword] --subreddit [subreddit name (without 'r/')]
```
# Donations
If you've got some change to spare and would like to show support, you can Buy Me A Coffee using the button below
### 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) |
<a href="https://www.buymeacoffee.com/189381184" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/default-orange.png" alt="Buy Me A Coffee" height="41" width="174"></a>
## 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)
Your support will be much appreciated😊