Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/jonfairbanks/subredditmapper

Discover related subreddits
https://github.com/jonfairbanks/subredditmapper

reddit reddit-api reddit-crawler

Last synced: 18 days ago
JSON representation

Discover related subreddits

Awesome Lists containing this project

README

        

# SubredditMapper
API to discover related subreddits

### Setup

- Python 3.x
- [Create a Reddit App](https://towardsdatascience.com/how-to-use-the-reddit-api-in-python-5e05ddfd1e5c)

### Usage

Pass a client id (-c), client secret (-s), username (-u) and password (-p) to get started:

```
python3 main.py -c -s -u -p
```

Once the app has started navigate to Port 5000 in your browser to continue.

### Endpoints

- `/`: Health endpoint (returns "OK")
- `/api/parse/`: Parse a subreddit for related content

### To Do

- [ ] Parallelization for Subreddit mapping
- [x] Refactor Code
- [ ] Finalize JSON format
- [x] HTTP API Support
- [ ] [Visualization Support](https://fperucic.github.io/treant-js/examples/collapsable/)
- [ ] Docker Image