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-10 20:02:52 +02:00
committed by GitHub
parent c5885bb41b
commit 4a06a29963
1 changed files with 25 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

42
README.md
View File

@@ -1,39 +1,47 @@
![Screenshot 2022-10-15 231821](https://user-images.githubusercontent.com/74001397/197303749-45032662-810d-4577-b546-13b93d4986d5.png)
# Reddit Post Scraping Tool
Given a subreddit name and a keyword, this script will return all posts from a specified listing (default is 'top') that contain the provided keyword.
![Screenshot 2023-02-10 195818](https://user-images.githubusercontent.com/74001397/218163494-245f6676-1fb3-4680-a6b5-bd15fb1dea5e.png)
![Screenshot_20230210_193329](https://user-images.githubusercontent.com/74001397/218158084-9295abb7-df33-4f86-8df8-e109cac7cde6.png)
# Installation
**1. Clone the repo**
### 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)
```
git clone https://github.com/rly0nheart/reddit-post-scraping-tool.git
pip install reddit-post-scraping-tool
```
**2. Move to reddit-post-scraping-tool directory**
### Install the dev version from [GitHub](https://github.com/rly0nheart/reddit-post-scraping-tool)
#### Note
> The dev version might be unstable
```
cd reddit-post-scraping-tool
pip install git+https://github.com/rly0nheart/reddit-post-scraping-tool
```
**3. Install dependencies**
```
pip3 install -r requirements.txt
```
# Usage
### Usage
```
python3 reddit-post-scraping-tool.py --keyword [keyword] --subreddit [subreddit name (without 'r/')]
reddit_post_scraping_tool --keyword [keyword] --subreddit [subreddit name (without 'r/')]
```
## Optional arguments
### 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) |
# Windows GUI
## Prerequisites
## 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