Skip to main content

Low-level communication layer for PRAW 4+.

Project description

Latest prawcore Version https://travis-ci.org/praw-dev/prawcore.svg?branch=main https://coveralls.io/repos/github/praw-dev/prawcore/badge.svg?branch=main

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 essense, 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.3.0.tar.gz (1.2 MB view details)

Uploaded Source

Built Distribution

prawcore-2.3.0-py3-none-any.whl (16.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: prawcore-2.3.0.tar.gz
  • Upload date:
  • Size: 1.2 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.57.0 CPython/3.9.1

File hashes

Hashes for prawcore-2.3.0.tar.gz
Algorithm Hash digest
SHA256 daf1ccd4b7a80dc4e6567d48336d782e94a9a6dad83770fc2edf76dc9a84f56d
MD5 c787afb47fee78ca1a04f706f5468090
BLAKE2b-256 ed8513e76be737f3159514cce609b29e95499ba6d2cfa0b88761bab318b5f63e

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: prawcore-2.3.0-py3-none-any.whl
  • Upload date:
  • Size: 16.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.57.0 CPython/3.9.1

File hashes

Hashes for prawcore-2.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 48c17db447fa06a13ca3e722201f443031437708daa736c05a1df895fbcceff5
MD5 4aa4624554bbe737552fb9d75696ede2
BLAKE2b-256 d63655cc2cab22aafbebd52ddac4ccb670b920b54eb6ddbdb8573c79ca870d8a

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