Metadata-Version: 1.1
Name: redditanalysis
Version: 0.1
Summary: A tool to aid in the production of word clouds for subreddits and users on reddit.
Home-page: https://github.com/rhiever/reddit-analysis
Author: Randy Olson
Author-email: rso@randalolson.com
License: GPLv3
Description: # Reddit Analysis project
        
        Please send all requests to make a Most-Used Words (MUW) word cloud to http://www.reddit.com/r/MUWs/
        
        Feel free to post the MUWs you've made there, too.
        
        ## License
        
        Copyright 2013 Randal S. Olson.
        
        This program is free software: you can redistribute it and/or modify it under
        the terms of the GNU General Public License as published by the Free Software
        Foundation, either version 3 of the License, or (at your option) any later
        version.
        
        This program is distributed in the hope that it will be useful, but WITHOUT ANY
        WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
        PARTICULAR PURPOSE. See the GNU General Public License for more details.
        
        You should have received a copy of the GNU General Public License along with
        this program. If not, see http://www.gnu.org/licenses/.
        
        ## Dependencies
        
        You must first install the Python library if you do not have that already.
        Preferably, use the <a href="http://www.enthought.com/products/epd_free.php"
        target="_blank">Enthought Python Distribution</a> (EPD) for an easy install.
        
        Next, you can install this package. Enter the following command into the
        terminal:
        
            easy_install redditanalysis
        
        You may need to put `sudo` in front of the above command if your system
        requires root access.
        
        If you want to install the lastest development version from github first
        clone the package and then run:
        
            python setup.py install
        
        
        ## Files in this repository
        
        `redditanalysis/common-words.txt` is a data file containing a list of words
        that should be considered common. Note that this list is not final and is
        constantly changing.
        
        `data_dumps/*.csv` are all of the word dumps we've added to the repo. Usually
        we only add the data dumps by request.
        
        
        ## Usage
        
        Once installed running the following on your command line should produce a
        usage message:
        
            word_freqs --help
        
        This command will detail all of the command line options and arguments for the
        script.
        
        ### Make a word cloud for a subreddit or redditor
        
        To count the most-used words for a subreddit over the last month, enter the
        following command:
        
            word_freqs YOUR-USERNAME /r/SUBREDDIT
        
        Similarly, for a reddit user:
        
            word_freqs YOUR-USERNAME /u/REDDITOR
        
        where `YOUR-USERNAME` is your reddit username and `SUBREDDIT` / `REDDITOR` is
        the subreddit / redditor you want to make the word cloud for. You
        must provide *both* arguments for the script to work properly.
        
        Once the script completes, it will create a file called `SUBREDDIT.csv` (or
        `user-REDDITOR.csv`) to the directory you ran it in. This file contains all of
        the commonly-used words from the subreddit / redditor you specified in the
        frequencies they were used.
        
        To make a word cloud out of the words, copy all of the words into
        http://www.wordle.net/compose and click the Go button. Ta-da, you're done!
        
Platform: UNKNOWN
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
