Metadata-Version: 2.1
Name: redditcommentcloud
Version: 0.1.1
Summary: Python3.7+ wrapper for generating word clouds from a Reddit user's comments.
Home-page: https://github.com/chmey/reddit-comment-cloud
Author: Christoph Meyer
Author-email: christoph@chmey.com
License: GPLv3
Keywords: reddit,wordcloud
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3
Description-Content-Type: text/markdown
Requires-Dist: matplotlib
Requires-Dist: praw
Requires-Dist: WordCloud

# Reddit Comment Cloud

Python3.7+ wrapper for generating word clouds from a Reddit user's comments.

![Reddit Comment Cloud for /u/SuddenlySnowden](SuddenlySnowden.png)

## Built upon
+ [PRAW](https://github.com/praw-dev/praw) (Python Reddit API Wrapper)
+ [WordCloud](https://github.com/amueller/word_cloud)
+ matplotlib

## Use
This example will render the WordCloud of /u/SuddenlySnowden and save the image under _SuddenlySnowden.png_ in the current working directory.

```
from redditcommentcloud import CommentCloud
cc = CommentCloud()
cc.renderWordCloud(username='SuddenlySnowden')
```


## Install
The code was written for Python3.7+.

__Optionally__: Create a Python virtual environment:
```
python -m venv .venv
source .venv/bin/activate
```
Type `deactivate` when you are done

__Clone this repository__ or install it using `pip install redditcommentcloud`.

__Installing the dependencies__
```
pip install -r requirements.txt
```

__Supply Reddit API credentials__
This tool requires API credentials for the Reddit API.
Go to https://www.reddit.com/prefs/apps/, create an app and copy the keys.

Copy `redditcommentcloud/config.py.template` to `redditcommentcloud/config.py` and fill in the details.
Freely choose a presumably unique User-Agent for the bot.


