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=master https://coveralls.io/repos/github/praw-dev/prawcore/badge.svg?branch=master

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/master/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.0.0.tar.gz (1.1 MB view details)

Uploaded Source

Built Distribution

prawcore-2.0.0-py3-none-any.whl (15.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: prawcore-2.0.0.tar.gz
  • Upload date:
  • Size: 1.1 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.0.0.tar.gz
Algorithm Hash digest
SHA256 b498d9b6f54991005e727d5235c8f49ea5ba0c9a6d793fb743b40fa089cd36d1
MD5 5559b7f442e36d641410e30fea25a20a
BLAKE2b-256 2308e2f19da55b7a74652f9ad66fc9f8ef1ebae234e56e5e6fe10b62517da7d1

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: prawcore-2.0.0-py3-none-any.whl
  • Upload date:
  • Size: 15.5 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.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 2353c0de28a01ccd39615f3ba0975d0781e4b51d2913f0965903dd98ebdd9a75
MD5 5fae09faaea772a7678b7e11742dc53c
BLAKE2b-256 7ddf4a9106bea0d26689c4b309da20c926a01440ddaf60c09a5ae22684ebd35f

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