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 OpenSSF Scorecard Contributor Covenant pre-commit

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-3.0.2.tar.gz (15.9 kB view details)

Uploaded Source

Built Distribution

prawcore-3.0.2-py3-none-any.whl (17.1 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for prawcore-3.0.2.tar.gz
Algorithm Hash digest
SHA256 15b2a2bc0ee0269d472f56b98c77e1d41c68b80f6fe72d3cb7bf784ed6cf259c
MD5 657cd9f464db63e1515541cab212630c
BLAKE2b-256 2a319ece8cce3689fe72a7f25565c2b60e1d88dee518b8936efdf00e3bd1eb94

See more details on using hashes here.

Provenance

The following attestation bundles were made for prawcore-3.0.2.tar.gz:

Publisher: pypi.yml on praw-dev/prawcore

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

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

File metadata

  • Download URL: prawcore-3.0.2-py3-none-any.whl
  • Upload date:
  • Size: 17.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.8

File hashes

Hashes for prawcore-3.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 f8a656de23dbc457b258739cafd626f8d0e60014b4ee17b10c5323d00ee1ebfc
MD5 1d2742dfcf9c57908fbdf3321e07ddbc
BLAKE2b-256 88eecbf4dab1547cf4b7eed331529230b393f18ae3d84d6f71c9c73f24f14418

See more details on using hashes here.

Provenance

The following attestation bundles were made for prawcore-3.0.2-py3-none-any.whl:

Publisher: pypi.yml on praw-dev/prawcore

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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