praw 4.0.0b1

PRAW, an acronym for `Python Reddit API Wrapper`, is a python package that allows for simple access to reddit's API.

PRAW, an acronym for “Python Reddit API Wrapper”, is a python package that allows for simple access to reddit’s API. PRAW aims to be as easy to use as possible and is designed to follow all of reddit’s API rules. You have to give a useragent that follows the rules, everything else is handled by PRAW so you needn’t worry about violating them.

Here’s a quick peek, getting the first 5 submissions from the ‘hot’ section of the ‘opensource’ subreddit:

>>> import praw
>>> r = praw.Reddit(user_agent='my_cool_application')
>>> submissions = r.get_subreddit('opensource').get_hot(limit=5)
>>> [str(x) for x in submissions]

This will display something similar to the following:

['10 :: Gun.io Debuts Group Funding for Open Source Projects\n Gun.io',
 '24 :: Support the Free Software Foundation',
 '67 :: The 10 Most Important Open Source Projects of 2011',
 '85 :: Plan 9 - A distributed OS with a unified communicatioprotocol  I/O...',
  '2 :: Open-source webOS is dead on arrival ']

Installation

PRAW is supported on python 2.7, 3.3, 3.4 and 3.5. The recommended way to install is via pip

$ pip install praw

If you want to run the development version of PRAW try:

$ pip install --upgrade https://github.com/praw-dev/praw/archive/master.zip

If you don’t have pip installed, then the Hitchhiker’s Guide to Python has a section for setting it up on Windows, Mac and Linux. There is also a Stack overflow question on installing pip on Windows that might prove helpful.

Alternatively you can do it via easy_install

$ easy_install praw

Support

The official place to ask questions about PRAW, reddit and other API wrappers is r/redditdev. If the question is more about Python and less about PRAW, such as “what are generators”, then you’re likely to get more, faster and more in-depth answers in r/learnpython.

If you’ve uncovered a bug or have a feature request, then make an issue on our project page at github.

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Documentation

PRAW’s documentation, which includes tutorials, information on configuring PRAW and other good stuff can be found at readthedocs.

License

All of the code contained here is licensed by the GNU GPLv3.