Skip to main content

"Low-level communication layer for PRAW 4+.

Project description

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

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

Installation

Install prawcore using pip via:

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.

#!/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:

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

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

requirements.txt

prawcore >=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

prawcore-2.4.0.tar.gz (15.9 kB view details)

Uploaded Source

Built Distribution

prawcore-2.4.0-py3-none-any.whl (17.2 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for prawcore-2.4.0.tar.gz
Algorithm Hash digest
SHA256 b7b2b5a1d04406e086ab4e79988dc794df16059862f329f4c6a43ed09986c335
MD5 7988456227a1e5f1d79538dcf0b1ffa3
BLAKE2b-256 8a62d4c99cf472205f1e5da846b058435a6a7c988abf8eb6f7d632a7f32f4a77

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: prawcore-2.4.0-py3-none-any.whl
  • Upload date:
  • Size: 17.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/4.0.2 CPython/3.11.5

File hashes

Hashes for prawcore-2.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 29af5da58d85704b439ad3c820873ad541f4535e00bb98c66f0fbcc8c603065a
MD5 685f9e0570f33dd3963240c6782d6730
BLAKE2b-256 965c8af904314e42d5401afcfaff69940dc448e974f80f7aa39b241a4fbf0cf1

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