Skip to main content

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

Project description

Latest asyncprawcore Version Supported Python Versions PyPI - Downloads - Monthly GitHub Actions Status Coveralls Coverage OpenSSF Scorecard Contributor Covenant pre-commit Black code style

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

Installation

Install asyncprawcore using pip via:

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.

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:

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

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

requirements.txt

asyncprawcore >=1.5.1, <2

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

asyncprawcore-2.4.0.tar.gz (18.1 kB view details)

Uploaded Source

Built Distribution

asyncprawcore-2.4.0-py3-none-any.whl (19.7 kB view details)

Uploaded Python 3

File details

Details for the file asyncprawcore-2.4.0.tar.gz.

File metadata

  • Download URL: asyncprawcore-2.4.0.tar.gz
  • Upload date:
  • Size: 18.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/4.0.2 CPython/3.11.6

File hashes

Hashes for asyncprawcore-2.4.0.tar.gz
Algorithm Hash digest
SHA256 3a3359e5cd1ebe61d544a09d4b5eca7b16edfd17de07081a8415fc794f7bb62e
MD5 ae21572fce05f3d494971064c8d265f0
BLAKE2b-256 1e0a45dfc8c3b91d74f646817db3e89baecbd963a8374e2a8a33f2eb83c7e398

See more details on using hashes here.

Provenance

File details

Details for the file asyncprawcore-2.4.0-py3-none-any.whl.

File metadata

File hashes

Hashes for asyncprawcore-2.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 3fe0f85d783ad0fd2a5d68d219b576bdbe04260ad7195c8a035d8724f57cfa45
MD5 9bcde13c8b3bdf2fe787ca9cc5a0771e
BLAKE2b-256 1da0a1f216c7ad7fd94482242eb92d6903c0ed5f3340436b952db2a42d2eddeb

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page