<commit_before>Introduction
-------------
This is a Python wrapper for Reddit's API, aiming to be as easy to use as possible. Here's a quick peek, getting the first 10 stories from the 'hot' section of the 'opensource' subreddit.

    import reddit
    r=reddit.Reddit()
    stories = r.get_subreddit('opensource').get_hot(limit=10)

13 Short Examples
---------------

1. Logging in:

        r.login(user="username", password="password")

2. Get stories:

        stories = subreddit.get_top(limit=10)

3. Voting:

        story.upvote()
        story.downvote()
        story.vote(direction=0)

4. Get user karma:

        user = r.get_redditor("username")
        print (user.link_karma, user.comment_karma)

5. Comment on story (after login):

        story.comment("text")

6. Reply to comment:

        comment.reply("test")

7. Get user's saved links:

        r.get_saved_links()

8. Print url's of user's saved links:

        saved = r.get_saved_links()
        for save in saved:
            print save.url

9. Get comments from all reddits:

        r.get_comments(limit=25)

10. Get content newer than a place-holder id:

        subreddit.get_top(limit=-1, place_holder=story_id)

11. Get comments from a given story:

        story.get_comments()

12. Subscribe to a subreddit:

        subreddit.subscribe()

13. Save a submission:

        submission.save()

Other (more involved) examples can be found [here](http://www.github.com/mellort/reddit_api/blob/master/EXAMPLES.md).

Features
-------------
Completed:

* login
* save
* subscribe
* voting
* get hot, top, controversial, overview, submitted
* get all comments
* commenting/replying
* caching results

Not Included (yet):

* friending<commit_msg>Slight README bump.<commit_after>Introduction
-------------
This is a Python wrapper for Reddit's API, aiming to be as easy to use as possible. Here's a quick peek, getting the first 10 stories from the 'hot' section of the 'opensource' subreddit.

    import reddit
    r=reddit.Reddit()
    stories = r.get_subreddit('opensource').get_hot(limit=10)

13 Short Examples
---------------

1. Logging in:

        r.login(user="username", password="password")

2. Get stories:

        stories = subreddit.get_top(limit=10)

3. Voting:

        story.upvote()
        story.downvote()
        story.vote(direction=0)

4. Get user karma:

        user = r.get_redditor("username")
        print (user.link_karma, user.comment_karma)

5. Comment on story (after login):

        story.comment("text")

6. Reply to comment:

        comment.reply("test")

7. Get user's saved links:

        r.get_saved_links()

8. Print url's of user's saved links:

        saved = r.get_saved_links()
        for save in saved:
            print save.url

9. Get comments from all reddits:

        r.get_comments(limit=25)

10. Get content newer than a place-holder id:

        subreddit.get_top(limit=-1, place_holder=story_id)

11. Get comments from a given story:

        story.get_comments()

12. Subscribe to a subreddit:

        subreddit.subscribe()

13. Save a submission:

        submission.save()

14. Create a subreddit:

        s = Subreddit("MyIncredibleSubreddit", r)
        s.create(title="My Incredibly Cool Subreddit", description="It's just incredible.")

15. Friend a user:

        r.friend("ketralnis")

Other (more involved) examples can be found [here](http://www.github.com/mellort/reddit_api/blob/master/EXAMPLES.md).

Features
-------------
Completed:

* login
* save
* subscribe
* voting
* get hot, top, controversial, overview, submitted
* get all comments
* commenting/replying
* caching results

Not Included (yet):

* friending
{'fraction_non_alphanumeric': 0.12271611671666212, 'fraction_numerical': 0.016907553858740116, 'mean_word_length': 2.7163120567375887, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 0, 'lorem ipsum': 0, 'www.': 2, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '5638063', 'n_tokens_mistral': 1186, 'n_tokens_neox': 1138, 'n_words': 352}