Skip to content
PRAW, an acronym for "Python Reddit API Wrapper", is a python package that allows for simple access to Reddit's API.
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Update contributing documentation Mar 8, 2019
docs Format code using the tool black Mar 7, 2019
praw Added the ability to pass arguments to the function in stream_generator Apr 6, 2019
tests Change mode from 755 to 644 on test_widgets.py (integration) Mar 24, 2019
.gitignore
.pre-commit-config.yaml
.pylintrc Format code using the tool black Mar 7, 2019
.readthedocs.yml Add index to documentation Feb 19, 2017
.travis.yml Add pyproject.toml file Mar 8, 2019
AUTHORS.rst
CHANGES.rst Added the ability to pass arguments to the function in stream_generator Apr 6, 2019
CODE_OF_CONDUCT.md Update code of conduct to contributor covenant 1.4.0. Jul 23, 2016
LICENSE.txt Use less restrictive Simplified BSD License. Aug 16, 2016
MANIFEST.in
README.rst
pre_push.py Return None from subreddit.random when necessary Mar 9, 2019
profile_tests.sh Add Subreddit.message and Redditor.message. Jul 4, 2016
pyproject.toml Return None from subreddit.random when necessary Mar 9, 2019
pytest.ini
setup.cfg Format code using the tool black Mar 7, 2019
setup.py Run black as a pre-commit hook Mar 8, 2019
tox.ini Remove support for python 3.3 Feb 10, 2018

README.rst

PRAW: The Python Reddit API Wrapper

Latest PRAW Version Travis CI Status Coveralls Coverage Join the chat at https://gitter.im/praw-dev/praw

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 easy to use and internally follows all of Reddit's API rules. With PRAW there's no need to introduce sleep calls in your code. Give your client an appropriate user agent and you're set.

Installation

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

pip install praw

To install the latest development version of PRAW run the following instead:

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

For instructions on installing python and pip see "The Hitchhiker's Guide to Python" Installation Guides.

Quickstart

Assuming you already have a credentials for a script-type OAuth application you can instantiate an instance of PRAW like so:

import praw
reddit = praw.Reddit(client_id='CLIENT_ID', client_secret="CLIENT_SECRET",
                     password='PASSWORD', user_agent='USERAGENT',
                     username='USERNAME')

With the reddit instance you can then interact with Reddit:

# Create a submission to /r/test
reddit.subreddit('test').submit('Test Submission', url='https://reddit.com')

# Comment on a known submission
submission = reddit.submission(url='https://www.reddit.com/comments/5e1az9')
submission.reply('Super rad!')

# Reply to the first comment of a weekly top thread of a moderated community
submission = next(reddit.subreddit('mod').top('week'))
submission.comments[0].reply('An automated reply')

# Output score for the first 256 items on the frontpage
for submission in reddit.front.hot(limit=256):
    print(submission.score)

# Obtain the moderator listing for redditdev
for moderator in reddit.subreddit('redditdev').moderator:
    print(moderator)

Please see PRAW's documentation for more examples of what you can do with PRAW.

PRAW Discussion and Support

For those new to python, or would otherwise consider themselves a python beginner, please consider asking questions on the r/learnpython subreddit. There are wonderful people there who can help with general python and simple PRAW related questions.

Otherwise, there are a few official places to ask questions about PRAW:

/r/redditdev is the best place on Reddit to ask PRAW related questions. This subreddit is for all Reddit API related discussion so please tag submissions with [PRAW]. Please perform a search on the subreddit first to see if anyone has similar questions.

Real-time chat can be conducted via the praw-dev/praw channel on gitter.

Please do not directly message any of the contributors via Reddit, email, or gitter unless they have indicated otherwise. We strongly encourage everyone to help others with their questions.

Please file bugs and feature requests as issues on GitHub after first searching to ensure a similar issue was not already filed. If such an issue already exists please give it a thumbs up reaction. Comments to issues containing additional information are certainly welcome.

Note

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 is located at http://praw.readthedocs.io/.

History

August 2010: Timothy Mellor created a github project called reddit_api.

March 2011: The python package reddit was registered and uploaded to pypi.

December 2011: Bryce Boe took over as maintainer of the reddit package.

June 2012: Bryce renamed the project PRAW and the repository was relocated to the newly created praw-dev organization on GitHub.

February 2016: Bryce began work on PRAW4, a complete rewrite of PRAW.

License

PRAW's source (v4.0.0+) is provided under the Simplified BSD License.

  • Copyright (c), 2016, Bryce Boe

Earlier versions of PRAW were released under GPLv3.

You can’t perform that action at this time.