praw


Namepraw JSON
Version 4.3.0 PyPI version JSON
home_pagehttps://praw.readthedocs.org/
SummaryPRAW, an acronym for `Python Reddit API Wrapper`, is a python package that allows for simple access to reddit's API.
upload_time2017-01-19 17:13:14
maintainer
docs_urlNone
authorBryce Boe
requires_python
licenseSimplified BSD License
keywords reddit api wrapper
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
Coveralis test coverage No Coveralis.
            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
.. image:: https://img.shields.io/badge/donate-cash.me%2F%24praw-blue.svg
   :alt: Donate via https://cash.me/$praw
   :target: https://cash.me/$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>`_.

Donations
---------

Please consider donating to PRAW's maintainer via https://cash.me/$praw.

            

Raw data

            {
    "maintainer": "", 
    "docs_url": null, 
    "requires_python": "", 
    "maintainer_email": "", 
    "cheesecake_code_kwalitee_id": null, 
    "keywords": "reddit api wrapper", 
    "upload_time": "2017-01-19 17:13:14", 
    "author": "Bryce Boe", 
    "home_page": "https://praw.readthedocs.org/", 
    "download_url": "https://pypi.python.org/packages/4a/c8/1ee38d868a5593b1ea259c7cf273f8c17dec8b45940105db61c7da3984e9/praw-4.3.0.tar.gz", 
    "platform": "", 
    "version": "4.3.0", 
    "cheesecake_documentation_id": null, 
    "description": "PRAW: The Python Reddit API Wrapper\n===================================\n\n.. image:: https://img.shields.io/pypi/v/praw.svg\n   :alt: Latest PRAW Version\n   :target: https://pypi.python.org/pypi/praw\n.. image:: https://travis-ci.org/praw-dev/praw.svg?branch=master\n   :alt: Travis CI Status\n   :target: https://travis-ci.org/praw-dev/praw\n.. image:: https://coveralls.io/repos/github/praw-dev/praw/badge.svg?branch=master\n   :alt: Coveralls Coverage\n   :target: https://coveralls.io/github/praw-dev/praw?branch=master\n.. image:: https://badges.gitter.im/praw-dev/praw.svg\n   :alt: Join the chat at https://gitter.im/praw-dev/praw\n   :target: https://gitter.im/praw-dev/praw\n.. image:: https://img.shields.io/badge/donate-cash.me%2F%24praw-blue.svg\n   :alt: Donate via https://cash.me/$praw\n   :target: https://cash.me/$praw\n\nPRAW, an acronym for \"Python Reddit API Wrapper\", is a python package that\nallows for simple access to Reddit's API. PRAW aims to be easy to use and\ninternally follows all of `Reddit's API rules\n<https://github.com/reddit/reddit/wiki/API>`_. With PRAW there's no need to\nintroduce ``sleep`` calls in your code. Give your client an appropriate user\nagent and you're set.\n\n.. _installation:\n\nInstallation\n------------\n\nPRAW is supported on python 2.7, 3.3, 3.4, 3.5 and 3.6. The recommended way to\ninstall PRAW is via `pip <https://pypi.python.org/pypi/pip>`_.\n\n.. code-block:: bash\n\n   pip install praw\n\nTo install the latest development version of PRAW run the following instead:\n\n.. code-block:: bash\n\n   pip install --upgrade https://github.com/praw-dev/praw/archive/master.zip\n\nFor instructions on installing python and pip see \"The Hitchhiker's Guide to\nPython\" `Installation Guides\n<http://docs.python-guide.org/en/latest/starting/installation/>`_.\n\nQuickstart\n----------\n\nAssuming you already have a credentials for a script-type OAuth application you\ncan instantiate an instance of PRAW like so:\n\n.. code-block:: python\n\n  import praw\n  reddit = praw.Reddit(client_id='CLIENT_ID', client_secret=\"CLIENT_SECRET\",\n                       password='PASSWORD', user_agent='USERAGENT',\n                       username='USERNAME')\n\nWith the ``reddit`` instance you can then interact with Reddit:\n\n.. code-block:: python\n\n  # Create a submission to /r/test\n  reddit.subreddit('test').submit('Test Submission', url='https://reddit.com')\n\n  # Comment on a known submission\n  submission = reddit.submission(url='https://www.reddit.com/comments/5e1az9')\n  submission.reply('Super rad!')\n\n  # Reply to the first comment of a weekly top thread of a moderated community\n  submission = next(reddit.subreddit('mod').top('week'))\n  submission.comments[0].reply('An automated reply')\n\n  # Output score for the first 256 items on the frontpage\n  for submission in reddit.front.hot(limit=256):\n      print(submission.score)\n\n  # Obtain the moderator listing for redditdev\n  for moderator in reddit.subreddit('redditdev').moderator:\n      print(moderator)\n\nPlease see PRAW's `documentation <http://praw.readthedocs.io/>`_ for\nmore examples of what you can do with PRAW.\n\nPRAW Discussion and Support\n---------------------------\n\nFor those new to python, or would otherwise consider themselves a python\nbeginner, please consider asking questions on the `r/learnpython\n<https://www.reddit.com/r/learnpython>`_ subreddit. There are wonderful people\nthere who can help with general python and simple PRAW related questions.\n\nOtherwise, there are a few official places to ask questions about PRAW:\n\n`/r/redditdev <https://www.reddit.com/r/redditdev>`_ is the best place on\nReddit to ask PRAW related questions. This subreddit is for all Reddit API\nrelated discussion so please tag submissions with *[PRAW]*. Please perform a\nsearch on the subreddit first to see if anyone has similar questions.\n\nReal-time chat can be conducted via the `praw-dev/praw\n<https://gitter.im/praw-dev/praw>`_ channel on gitter.\n\nPlease do not directly message any of the contributors via Reddit, email, or\ngitter unless they have indicated otherwise. We strongly encourage everyone to\nhelp others with their questions.\n\nPlease file bugs and feature requests as issues on `GitHub\n<https://github.com/praw-dev/praw/issues>`_ after first searching to ensure a\nsimilar issue was not already filed. If such an issue already exists please\ngive it a thumbs up reaction. Comments to issues containing additional\ninformation are certainly welcome.\n\n.. note:: This project is released with a `Contributor Code of Conduct\n   <https://github.com/praw-dev/praw/blob/master/CODE_OF_CONDUCT.md>`_. By\n   participating in this project you agree to abide by its terms.\n\nDocumentation\n-------------\n\nPRAW's documentation is located at http://praw.readthedocs.io/.\n\nHistory\n-------\n\n`August 2010\n<https://github.com/praw-dev/praw/commit/efef08a4a713fcfd7dfddf992097cf89426586ae>`_:\nTimothy Mellor created a github project called ``reddit_api``.\n\n`March 2011\n<https://github.com/praw-dev/praw/commit/ebfc9caba5b58b9e68c77af9c8e53f5562a2ee64>`_:\nThe python package ``reddit`` was registered and uploaded to pypi.\n\n`December 2011\n<https://github.com/praw-dev/praw/commit/74bb962b3eefe04ce6acad88e6f53f43d10c8803>`_:\nBryce Boe took over as maintainer of the ``reddit`` package.\n\n`June 2012\n<https://github.com/praw-dev/praw/commit/adaf89fe8631f41ab9913b379de104c9ef6a1e73>`_:\nBryce renamed the project ``PRAW`` and the repository was relocated to the\nnewly created praw-dev organization on GitHub.\n\n`February 2016\n<https://github.com/praw-dev/praw/commit/252083ef1dbfe6ea53c2dc99ac235b4ba330b658>`_:\nBryce began work on PRAW4, a complete rewrite of PRAW.\n\n\nLicense\n-------\n\nPRAW's source (v4.0.0+) is provided under the `Simplified BSD License\n<https://github.com/praw-dev/praw/blob/0860c11a9309c80621c267af7caeb6a993933744/LICENSE.txt>`_.\n\n* Copyright (c), 2016, Bryce Boe\n\nEarlier versions of PRAW were released under `GPLv3\n<https://github.com/praw-dev/praw/blob/0c88697fdc26e75f87b68e2feb11e101e90ce215/COPYING>`_.\n\nDonations\n---------\n\nPlease consider donating to PRAW's maintainer via https://cash.me/$praw.\n", 
    "lcname": "praw", 
    "bugtrack_url": "", 
    "github": false, 
    "name": "praw", 
    "license": "Simplified BSD License", 
    "summary": "PRAW, an acronym for `Python Reddit API Wrapper`, is a python package that allows for simple access to reddit's API.", 
    "split_keywords": [
        "reddit", 
        "api", 
        "wrapper"
    ], 
    "author_email": "bbzbryce@gmail.com", 
    "urls": [
        {
            "has_sig": false, 
            "upload_time": "2017-01-19T17:13:04", 
            "comment_text": "", 
            "python_version": "3.6", 
            "url": "https://pypi.python.org/packages/47/c9/5b4bd7381dcf5b38b077a3c0a797c302500e4e61e4d58f11477ab1c70526/praw-4.3.0-py2.py3-none-any.whl", 
            "md5_digest": "32102a77a4b62cb110c4256a2d69a8fb", 
            "downloads": 0, 
            "filename": "praw-4.3.0-py2.py3-none-any.whl", 
            "packagetype": "bdist_wheel", 
            "path": "47/c9/5b4bd7381dcf5b38b077a3c0a797c302500e4e61e4d58f11477ab1c70526/praw-4.3.0-py2.py3-none-any.whl", 
            "size": 74582
        }, 
        {
            "has_sig": false, 
            "upload_time": "2017-01-19T17:13:14", 
            "comment_text": "", 
            "python_version": "source", 
            "url": "https://pypi.python.org/packages/4a/c8/1ee38d868a5593b1ea259c7cf273f8c17dec8b45940105db61c7da3984e9/praw-4.3.0.tar.gz", 
            "md5_digest": "6b728a7131891a6fb7b55a4763613f88", 
            "downloads": 0, 
            "filename": "praw-4.3.0.tar.gz", 
            "packagetype": "sdist", 
            "path": "4a/c8/1ee38d868a5593b1ea259c7cf273f8c17dec8b45940105db61c7da3984e9/praw-4.3.0.tar.gz", 
            "size": 4337108
        }
    ], 
    "_id": null, 
    "cheesecake_installability_id": null
}