Metadata-Version: 2.4
Name: prawcore
Version: 4.0.0
Summary: Low-level communication layer for PRAW 4+.
Project-URL: Documentation, https://prawcore.readthedocs.io/
Project-URL: Issue Tracker, https://github.com/praw-dev/prawcore/issues
Project-URL: Source Code, https://github.com/praw-dev/prawcore
Author-email: Bryce Boe <bbzbryce@gmail.com>
Maintainer-email: Bryce Boe <bbzbryce@gmail.com>, Joel Payne <lilspazjoekp@gmail.com>
License: Copyright (c) 2016, Bryce Boe
        All rights reserved.
        
        Redistribution and use in source and binary forms, with or without
        modification, are permitted provided that the following conditions are met:
        
        1. Redistributions of source code must retain the above copyright notice, this
           list of conditions and the following disclaimer.
        2. Redistributions in binary form must reproduce the above copyright notice,
           this list of conditions and the following disclaimer in the documentation
           and/or other materials provided with the distribution.
        
        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
        ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
        WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
        DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
        FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
        DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
        SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
        CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
        OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
        OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
License-File: AUTHORS.rst
License-File: LICENSE.txt
Keywords: api,praw,reddit
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Typing :: Typed
Requires-Python: >=3.10
Requires-Dist: requests<3.0,>=2.34.2
Description-Content-Type: text/x-rst

.. _main_page:

##########
 prawcore
##########

.. image:: https://img.shields.io/pypi/v/prawcore.svg
    :alt: Latest prawcore Version
    :target: https://pypi.python.org/pypi/prawcore

.. image:: https://img.shields.io/pypi/pyversions/prawcore
    :alt: Supported Python Versions
    :target: https://pypi.python.org/pypi/prawcore

.. image:: https://img.shields.io/pypi/dm/prawcore
    :alt: PyPI - Downloads - Monthly
    :target: https://pypi.python.org/pypi/prawcore

.. image:: https://github.com/praw-dev/prawcore/actions/workflows/ci.yml/badge.svg?event=push
    :alt: GitHub Actions Status
    :target: https://github.com/praw-dev/prawcore/actions/workflows/ci.yml

.. image:: https://api.securityscorecards.dev/projects/github.com/praw-dev/prawcore/badge
    :alt: OpenSSF Scorecard
    :target: https://api.securityscorecards.dev/projects/github.com/praw-dev/prawcore

.. image:: https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg
    :alt: Contributor Covenant
    :target: https://github.com/praw-dev/.github/blob/main/CODE_OF_CONDUCT.md

.. image:: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white
    :alt: pre-commit
    :target: https://github.com/pre-commit/pre-commit

prawcore is a low-level communication layer used by PRAW 4+.

**************
 Installation
**************

Install prawcore with `uv <https://docs.astral.sh/uv/>`_ via:

.. code-block:: console

    uv add prawcore

Alternatively, install using ``pip`` via:

.. code-block:: console

    pip install prawcore

*******************
 Execution Example
*******************

The following example demonstrates how to use prawcore to obtain the list of trophies
for a given user using the script-app type. This example assumes you have the
environment variables ``PRAWCORE_CLIENT_ID`` and ``PRAWCORE_CLIENT_SECRET`` set to the
appropriate values for your application.

.. code-block:: python

    #!/usr/bin/env python
    import os
    import pprint
    import prawcore

    authenticator = prawcore.TrustedAuthenticator(
        client_id=os.environ["PRAWCORE_CLIENT_ID"],
        client_secret=os.environ["PRAWCORE_CLIENT_SECRET"],
        requestor=prawcore.Requestor(user_agent="YOUR_VALID_USER_AGENT"),
    )
    authorizer = prawcore.ReadOnlyAuthorizer(authenticator=authenticator)
    authorizer.refresh()

    with prawcore.session(authorizer=authorizer) as session:
        pprint.pprint(session.request(method="GET", path="/api/v1/user/bboe/trophies"))

Save the above as ``trophies.py`` and then execute via:

.. code-block:: console

    python trophies.py

Additional examples can be found at:
https://github.com/praw-dev/prawcore/tree/main/examples

***************
 Documentation
***************

prawcore's documentation is located at https://prawcore.readthedocs.io/.

***********************
 Depending on prawcore
***********************

prawcore follows `semantic versioning <https://semver.org/>`_ with the exception that
deprecations will not be preceded by a minor release. In essence, expect only major
versions to introduce breaking changes to prawcore's public interface. As a result, if
you depend on prawcore then it is a good idea to specify not only the minimum version of
prawcore your package requires, but to also limit the major version.

Below are two examples of how you may want to specify your prawcore dependency:

setup.py
========

.. code-block:: python

    setup(..., install_requires=["prawcore >=0.1, <1"], ...)

requirements.txt
================

.. code-block:: text

    prawcore >=1.5.1, <2
