Initial commit

This commit is contained in:
2026-02-01 09:31:38 +01:00
commit e02db93960
4396 changed files with 1511612 additions and 0 deletions

View File

@@ -0,0 +1 @@
pip

View File

@@ -0,0 +1,22 @@
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.

View File

@@ -0,0 +1,149 @@
Metadata-Version: 2.1
Name: prawcore
Version: 2.4.0
Summary: "Low-level communication layer for PRAW 4+.
Keywords: praw,reddit,api
Author-email: Bryce Boe <bbzbryce@gmail.com>
Maintainer-email: Bryce Boe <bbzbryce@gmail.com>
Requires-Python: ~=3.8
Description-Content-Type: text/x-rst
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Natural Language :: English
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Dist: requests >=2.6.0, <3.0
Requires-Dist: coveralls ; extra == "ci"
Requires-Dist: packaging ; extra == "dev"
Requires-Dist: prawcore[lint] ; extra == "dev"
Requires-Dist: prawcore[test] ; extra == "dev"
Requires-Dist: pre-commit ; extra == "lint"
Requires-Dist: ruff >=0.0.291 ; extra == "lint"
Requires-Dist: betamax >=0.8, <0.9 ; extra == "test"
Requires-Dist: pytest >=2.7.3 ; extra == "test"
Requires-Dist: urllib3 ==1.26.*, <2 ; extra == "test"
Project-URL: Issue Tracker, https://github.com/praw-dev/prawcore/issues
Project-URL: Source Code, https://github.com/praw-dev/prawcore
Provides-Extra: ci
Provides-Extra: dev
Provides-Extra: lint
Provides-Extra: test
.. _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://coveralls.io/repos/github/praw-dev/prawcore/badge.svg
:alt: Coveralls Coverage
:target: https://coveralls.io/github/praw-dev/prawcore
.. 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
.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
:alt: Black code style
:target: https://github.com/psf/black
prawcore is a low-level communication layer used by PRAW 4+.
Installation
------------
Install prawcore 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(
prawcore.Requestor("YOUR_VALID_USER_AGENT"),
os.environ["PRAWCORE_CLIENT_ID"],
os.environ["PRAWCORE_CLIENT_SECRET"],
)
authorizer = prawcore.ReadOnlyAuthorizer(authenticator)
authorizer.refresh()
with prawcore.session(authorizer) as session:
pprint.pprint(session.request("GET", "/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
Depending on prawcore
---------------------
prawcore follows `semantic versioning <http://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

View File

@@ -0,0 +1,21 @@
prawcore-2.4.0.dist-info/INSTALLER,sha256=zuuue4knoyJ-UwPPXg8fezS7VCrXJQrAP7zeNuwvFQg,4
prawcore-2.4.0.dist-info/LICENSE.txt,sha256=qWD9mQsMaIPPjQAVp1-LHyZXzM8nWqgConwibDyGFIY,1296
prawcore-2.4.0.dist-info/METADATA,sha256=rrsFtPpW2X-b32hlS5PGsu9WlZq_uY8FNvItY2fowK0,4995
prawcore-2.4.0.dist-info/RECORD,,
prawcore-2.4.0.dist-info/WHEEL,sha256=EZbGkh7Ie4PoZfRQ8I0ZuP9VklN_TvcZ6DSE5Uar4z4,81
prawcore/__init__.py,sha256=GqAOwRAG7Z0tDlhb0kU0WFrIoRPVka2fu7Jt_B47QIo,462
prawcore/__pycache__/__init__.cpython-310.pyc,,
prawcore/__pycache__/auth.cpython-310.pyc,,
prawcore/__pycache__/const.cpython-310.pyc,,
prawcore/__pycache__/exceptions.cpython-310.pyc,,
prawcore/__pycache__/rate_limit.cpython-310.pyc,,
prawcore/__pycache__/requestor.cpython-310.pyc,,
prawcore/__pycache__/sessions.cpython-310.pyc,,
prawcore/__pycache__/util.cpython-310.pyc,,
prawcore/auth.py,sha256=lYsvm_iqOv054jurY6e4XlzFnqwe0mLsRs4ABwGRAoA,18399
prawcore/const.py,sha256=aUaHdEovvHOI89JEwEawMQrsHoq0aiOXsjZArYNxsX0,391
prawcore/exceptions.py,sha256=4U1jhLxOoOuHYEbQFJrT9Rsc63_jdDCnbO7x4PHb7Tw,6048
prawcore/rate_limit.py,sha256=g99ph39W-sVKJI2WcDHQVZFkwSbwrq7Du232nQHbBVM,3543
prawcore/requestor.py,sha256=LS1lZHQ2ySXy3CMhDjhNkBD4GW_-65ZYaD1WH01FNO8,2572
prawcore/sessions.py,sha256=v3Lq-93kWhzss_tcWvuLOwO6HFkGkVpS5LJGgwh0qpw,12373
prawcore/util.py,sha256=tr_QSQeDQLZNbzSw0nZNuJi0xSKrHF28NL8wqv1nrOo,880

View File

@@ -0,0 +1,4 @@
Wheel-Version: 1.0
Generator: flit 3.9.0
Root-Is-Purelib: true
Tag: py3-none-any