https://github.com/praw-dev/asyncprawcore

Low-level asynchronous communication layer for Async PRAW 7+.
https://github.com/praw-dev/asyncprawcore

Last synced: 12 months ago
JSON representation

Low-level asynchronous communication layer for Async PRAW 7+.

• Host: GitHub
• URL: https://github.com/praw-dev/asyncprawcore
• Owner: praw-dev
• License: bsd-2-clause
• Created: 2019-02-05T03:18:17.000Z (about 7 years ago)
• Default Branch: main
• Last Pushed: 2024-04-15T15:07:47.000Z (almost 2 years ago)
• Last Synced: 2024-04-22T13:08:45.485Z (almost 2 years ago)
• Language: Python
• Homepage:
• Size: 4.54 MB
• Stars: 6
• Watchers: 3
• Forks: 5
• Open Issues: 2
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGES.rst
  • License: LICENSE.txt
  • Authors: AUTHORS.rst

Awesome Lists containing this project

README

          
.. _main_page:

asyncprawcore

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

.. image:: https://img.shields.io/pypi/v/asyncprawcore.svg

    :alt: Latest asyncprawcore Version

    :target: https://pypi.python.org/pypi/asyncprawcore

.. image:: https://img.shields.io/pypi/pyversions/asyncprawcore

    :alt: Supported Python Versions

    :target: https://pypi.python.org/pypi/asyncprawcore

.. image:: https://img.shields.io/pypi/dm/asyncprawcore

    :alt: PyPI - Downloads - Monthly

    :target: https://pypi.python.org/pypi/asyncprawcore

.. image:: https://github.com/praw-dev/asyncprawcore/actions/workflows/ci.yml/badge.svg?event=push

    :alt: GitHub Actions Status

    :target: https://github.com/praw-dev/asyncprawcore/actions/workflows/ci.yml

.. image:: https://coveralls.io/repos/github/praw-dev/asyncprawcore/badge.svg

    :alt: Coveralls Coverage

    :target: https://coveralls.io/github/praw-dev/asyncprawcore

.. image:: https://api.securityscorecards.dev/projects/github.com/praw-dev/asyncprawcore/badge

    :alt: OpenSSF Scorecard

    :target: https://api.securityscorecards.dev/projects/github.com/praw-dev/asyncprawcore

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

asyncprawcore is a low-level communication layer used by Async PRAW 7+.

Installation

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

Install asyncprawcore using ``pip`` via:

.. code-block:: console

    pip install asyncprawcore

Execution Example

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

The following example demonstrates how to use asyncprawcore 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

    import os

    import pprint

    import asyncio

    import asyncprawcore

    async def main():

        authenticator = asyncprawcore.TrustedAuthenticator(

            asyncprawcore.Requestor("YOUR_VALID_USER_AGENT"),

            os.environ["PRAWCORE_CLIENT_ID"],

            os.environ["PRAWCORE_CLIENT_SECRET"],

        )

        authorizer = asyncprawcore.ReadOnlyAuthorizer(authenticator)

        await authorizer.refresh()

        async with asyncprawcore.session(authorizer) as session:

            pprint.pprint(await session.request("GET", "/api/v1/user/bboe/trophies"))

    if __name__ == "__main__":

        asyncio.run(main())

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/asyncprawcore/tree/main/examples

Depending on asyncprawcore

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

asyncprawcore follows `semantic versioning `_ with the exception

that deprecations will not be preceded by a minor release. In essence, expect only major

versions to introduce breaking changes to asyncprawcore's public interface. As a result,

if you depend on asyncprawcore then it is a good idea to specify not only the minimum

version of asyncprawcore your package requires, but to also limit the major version.

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

setup.py

~~~~~~~~

.. code-block:: python

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

requirements.txt

~~~~~~~~~~~~~~~~

.. code-block:: text

    asyncprawcore >=1.5.1, <2