Skip to main content

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

Project description

https://travis-ci.org/praw-dev/praw.svg?branch=master https://coveralls.io/repos/praw-dev/praw/badge.svg?branch=master

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.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

praw-4.0.0b5.tar.gz (2.4 MB view details)

Uploaded Source

Built Distribution

praw-4.0.0b5-py2.py3-none-any.whl (46.2 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file praw-4.0.0b5.tar.gz.

File metadata

  • Download URL: praw-4.0.0b5.tar.gz
  • Upload date:
  • Size: 2.4 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for praw-4.0.0b5.tar.gz
Algorithm Hash digest
SHA256 e21c0ef28268590281036c11009a24217185bb152fe82e35d2c3d6bd6ddcd017
MD5 09ded5b909c85d873024c1521383f334
BLAKE2b-256 85cae3c87a6855628fd60de10c79ec7c0eb7db24f23f1abb525bb7797dbab2fc

See more details on using hashes here.

Provenance

File details

Details for the file praw-4.0.0b5-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for praw-4.0.0b5-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 49d23e48441ce69c79c5f2c29547a14f68898132a35495da7984c4719735bcd4
MD5 ec23e52b4fa8bb87ed000d98294313c4
BLAKE2b-256 8624159c50c0fa9c5e5a50592f563148dab0c7efca8b58f3a8efe68a1cfe3ebb

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page