Are you happy with your logging solution? Would you help us out by taking a 30-second survey? Click here

praw

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

Subscribe to updates I use praw


Statistics on praw

Number of watchers on Github 1496
Number of open issues 3
Average time to close an issue 7 days
Main language Python
Average time to merge a PR 1 day
Open pull requests 9+
Closed pull requests 23+
Last commit over 1 year ago
Repo Created about 9 years ago
Repo Last Updated over 1 year ago
Size 39.8 MB
Homepage http://praw.readt...
Organization / Authorpraw-dev
Contributors95
Page Updated
Do you use praw? Leave a review!
View open issues (3)
View praw activity
View on github
Fresh, new opensource launches 🚀🚀🚀
Trendy new open source projects in your inbox! View examples

Subscribe to our mailing list

Evaluating praw for your project? Score Explanation
Commits Score (?)
Issues & PR Score (?)

PRAW: The Python Reddit API Wrapper

.. image:: https://img.shields.io/pypi/v/praw.svg :alt: Latest PRAW Version :target: https://pypi.python.org/pypi/praw .. image:: https://travis-ci.org/praw-dev/praw.svg?branch=master :alt: Travis CI Status :target: https://travis-ci.org/praw-dev/praw .. image:: https://coveralls.io/repos/github/praw-dev/praw/badge.svg?branch=master :alt: Coveralls Coverage :target: https://coveralls.io/github/praw-dev/praw?branch=master .. image:: https://badges.gitter.im/praw-dev/praw.svg :alt: Join the chat at https://gitter.im/praw-dev/praw :target: 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 <https://github.com/reddit/reddit/wiki/API>_. 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:

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 <https://pypi.python.org/pypi/pip>_.

.. code-block:: bash

pip install praw

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

.. code-block:: bash

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 <http://docs.python-guide.org/en/latest/starting/installation/>_.

Quickstart

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

.. code-block:: python

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:

.. code-block:: python

# 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 <http://praw.readthedocs.io/>_ 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 <https://www.reddit.com/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 <https://www.reddit.com/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 <https://gitter.im/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 <https://github.com/praw-dev/praw/issues>_ 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 <https://github.com/praw-dev/praw/blob/master/CODE_OF_CONDUCT.md>_. 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 <https://github.com/praw-dev/praw/commit/efef08a4a713fcfd7dfddf992097cf89426586ae>_: Timothy Mellor created a github project called reddit_api.

March 2011 <https://github.com/praw-dev/praw/commit/ebfc9caba5b58b9e68c77af9c8e53f5562a2ee64>_: The python package reddit was registered and uploaded to pypi.

December 2011 <https://github.com/praw-dev/praw/commit/74bb962b3eefe04ce6acad88e6f53f43d10c8803>_: Bryce Boe took over as maintainer of the reddit package.

June 2012 <https://github.com/praw-dev/praw/commit/adaf89fe8631f41ab9913b379de104c9ef6a1e73>_: Bryce renamed the project PRAW and the repository was relocated to the newly created praw-dev organization on GitHub.

February 2016 <https://github.com/praw-dev/praw/commit/252083ef1dbfe6ea53c2dc99ac235b4ba330b658>_: Bryce began work on PRAW4, a complete rewrite of PRAW.

License

PRAW's source (v4.0.0+) is provided under the Simplified BSD License <https://github.com/praw-dev/praw/blob/0860c11a9309c80621c267af7caeb6a993933744/LICENSE.txt>_.

  • Copyright (c), 2016, Bryce Boe

Earlier versions of PRAW were released under GPLv3 <https://github.com/praw-dev/praw/blob/0c88697fdc26e75f87b68e2feb11e101e90ce215/COPYING>_.

praw open issues Ask a question     (View All Issues)
  • almost 3 years PRAW4: Duplicate entries from subreddit().stream.submissions()
  • about 3 years PRAW4 To Do List
  • about 3 years Provide analog of praw.objects.Submission.replace_more_comments for praw.objects.Comment
  • over 3 years Dependency ranges too small
  • over 3 years Unhelpful exception raised from Celery task
  • over 3 years Add support for /randomrising
  • over 3 years Forbidden and Captcha errors with using update_settings [ver 3.3.0]
  • over 3 years Forbidden errors are silenced on SubmitMixin.submit
  • over 3 years Support for Reddit Live?
  • over 3 years Stack overflow when invalid subreddit fetched with get_subreddit
  • over 3 years Add version argument to get_wiki_page
  • over 3 years Allow sr quarantine optins and optouts
  • over 3 years "Edit on github" in readthedocs redirects to a 404
  • almost 4 years Post.replace_more_comments() function does not work with oauth
  • almost 4 years Voting should return a client exception if the given post / comment is archived
  • almost 4 years More info on #519 + inconsistency with the refresh method on comments due to reddit behavior
  • almost 4 years Add support for Subreddit-owned multireddits Multireddits
  • almost 4 years Refresh method exception
  • almost 4 years `comments` of the `submission` property does not give the full submission object
  • almost 4 years Use `raw_json=1`
  • almost 4 years submission_stream and comment_stream only get new data every second request
  • about 4 years An api for getting the parent comment's id, the body and the username of the commentor.
  • about 4 years Forbidden error when trying to retrieve content_md of a WikiPage object in a private subreddit
  • about 4 years Crashing on Non-Standard Characters When Getting a Submission
  • about 4 years Approving submissions from shadowbanned accounts doesn't work?
  • about 4 years Decoding a string using 'ascii' is dangerous
  • over 4 years Assertion Error while filling in a MoreComments object.
  • over 4 years MoreComments.comments() return value
  • over 4 years add_moderator() doesn't support non-full permissions
praw open pull requests (View All Pulls)
  • Patch rare refresh exception
  • PRAW - The TREES Update!
  • Add method for getting lazy instance of a comment.
  • Add method get_rules for a subreddit's rules
  • Add `LiveThreadContribution` class and `add_update()` method
  • Added the ability to delete comments from inbox
  • Comment by url
  • Add `store_json` property to keep json response from Reddit
  • Added Emoji Support to PRAW
praw questions on Stackoverflow (View All Questions)
  • How to look through post in Reddit with praw
  • subreddits of user using PRAW or R
  • Searching and Extracting Reddit data from Python using PRAW
  • How to return raw comment data in PRAW instead of memory address (Python 3.5)?
  • How can I make a list of the top comments in a subreddit with PRAW?
  • Reddit Praw Api usage to search submissions
  • Cx_Freezing a PySide, praw, requests application stops working when frozen
  • PRAW: Progress bar for replace_more_comments()?
  • PRAW: Authorizing with OAuth prevents me from getting submissions/comments
  • Pyinstaller binary not working with PRAW config
  • Detecting NSFW submissions with praw
  • How do you get the url from Submission object in PRAW?
  • Unicode Error when trying to process blank character text in PRAW
  • Help getting URL linked to by Reddit post With PRAW
  • recursion max error when when using futures.ProcessPoolExecutor but not futures.ThreadPoolExecutor with PRAW wrapper
  • How do I use PRAW and python to retrieve reddit post data from a certain user?
  • Pulling all posts from a single subreddit. Praw?
  • Python PRAW Converting Mobile Wikipedia Link to Non-Mobile
  • How to get a redditors most down voted comment using PRAW?
  • how do I install praw
  • Tkinter Reddit scraper (Tkinter and Praw) returns error "TypeError"
  • Praw script throws an error
  • Including the username of comment above in reply by bot with PRAW
  • PRAW: Grab All Root Level Comments for all of a User's Submissions...Quickly?
  • Cannot find PRAW config file when wrapping application with py2app
  • Problems using PRAW (searching and posting)
  • Can I obtain the most popular sub-reddits during a specified time frame using Reddit API PRAW?
  • Using PRAW to pull more than 1000 top entries
  • Submit Post with PRAW
  • 403 Client HTTPError when trying to connect to Reddit via praw
praw list of languages used
More projects by praw-dev View all
Other projects in Python