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 Join the chat at https://gitter.im/praw-dev/praw

prawcore is a low-level communication layer for 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-0.14.0.tar.gz (16.4 kB view details)

Uploaded Source

Built Distribution

prawcore-0.14.0-py2.py3-none-any.whl (15.1 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

  • Download URL: prawcore-0.14.0.tar.gz
  • Upload date:
  • Size: 16.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for prawcore-0.14.0.tar.gz
Algorithm Hash digest
SHA256 cc5c32ee8c1d1de212ade0ea319a21d3448cb151cb1ccb7335ba76ca96cf8f37
MD5 8eeab76815a4b4c219cbbf089c891fdd
BLAKE2b-256 159d032031a050a4e8f76c4a3a1220c94deb780c74e3b112ae00ebc28df8ccba

See more details on using hashes here.

Provenance

File details

Details for the file prawcore-0.14.0-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for prawcore-0.14.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 a8b6fda0d1f8f3135e888e4257a4e338e9866c39262031cd5a8cb91f9024f64b
MD5 6dd6b5661b616699d870fb876a982b82
BLAKE2b-256 d7eeb30eee52ec96c7fd5e7b9d49627385223ebd861610ef3d7be0f610b01f09

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