Skip to content

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

License

BSD-2-Clause, BSD-2-Clause licenses found

Licenses found

BSD-2-Clause
LICENSE.txt
BSD-2-Clause
prawcore_license.txt
Notifications You must be signed in to change notification settings

praw-dev/asyncprawcore

asyncprawcore

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

About

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

Resources

License

BSD-2-Clause, BSD-2-Clause licenses found

Licenses found

BSD-2-Clause
LICENSE.txt
BSD-2-Clause
prawcore_license.txt

Code of conduct

Stars

Watchers

Forks

Sponsor this project

  •  
  •  
  •  

Packages

No packages published

Languages