Metadata-Version: 1.1
Name: praw
Version: 3.5.0
Summary: PRAW, an acronym for `Python Reddit API Wrapper`, is a python package that allows for simple access to reddit's API.
Home-page: https://praw.readthedocs.org/
Author: Bryce Boe
Author-email: bbzbryce@gmail.com
License: GPLv3
Description: .. _main_page:

        

        PRAW: The Python Reddit API Wrapper

        ===================================

        

        .. begin_description

        

        .. image:: https://travis-ci.org/praw-dev/praw.svg?branch=master

                   :target: https://travis-ci.org/praw-dev/praw

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

          :target: https://coveralls.io/r/praw-dev/praw?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

        <https://github.com/reddit/reddit/wiki/API>`_. 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:

        

        .. code-block:: pycon

        

            >>> 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:

        

        .. code-block:: pycon

        

            ['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 ']

        

        .. end_description

        

        .. begin_installation

        

        .. _installation:

        

        Installation

        ------------

        

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

        install is via `pip <https://pypi.python.org/pypi/pip>`_

        

        .. code-block:: bash

        

            $ pip install praw

        

        

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

        

        .. code-block:: bash

        

            $ 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

        <http://docs.python-guide.org/en/latest/starting/install/win/>`_,

        `Mac <http://docs.python-guide.org/en/latest/starting/install/osx/>`_ and

        `Linux <http://docs.python-guide.org/en/latest/starting/install/linux/>`_.

        There is also a `Stack overflow question on installing pip on Windows

        <http://stackoverflow.com/questions/4750806/how-to-install-pip-on-windows>`_

        that might prove helpful.

        

        Alternatively you can do it via

        `easy_install <https://pypi.python.org/pypi/setuptools>`_

        

        .. code-block:: bash

        

            $ easy_install praw

        

        .. end_installation

        

        .. begin_support

        

        Support

        -------

        

        The official place to ask questions about PRAW, reddit and other API wrappers

        is `r/redditdev <https://www.reddit.com/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

        <https://www.reddit.com/r/learnpython>`_.

        

        If you've uncovered a bug or have a feature request, then `make an issue on our

        project page at github <https://github.com/praw-dev/praw/issues>`_.

        

        Please note that 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.

        

        .. end_support

        

        Documentation

        -------------

        

        PRAW's documentation, which includes tutorials, information on configuring PRAW

        and other good stuff can be found at `readthedocs

        <https://praw.readthedocs.org>`_.

        

        .. begin_license

        

        License

        -------

        

        All of the code contained here is licensed by

        `the GNU GPLv3 <https://github.com/praw-dev/praw/blob/master/COPYING>`_.

        

        .. end_license

        
Keywords: reddit api wrapper
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU General Public License (GPL)
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Topic :: Utilities
