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

Uploaded Source

Built Distribution

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

Uploaded Python 2 Python 3

File details

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

File metadata

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

File hashes

Hashes for prawcore-0.13.0.tar.gz
Algorithm Hash digest
SHA256 3fb71235d61307ed166b41e47fcd3f1167f9b1bb3630c5ebe1d83c00fd611d5a
MD5 1a1a3f0b185a1b9b34b6ea5765b95f2e
BLAKE2b-256 5ca7dbd9680546d31f2ad81e23512ddf06db5dcb8514fc1a34b1afa3d403be84

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for prawcore-0.13.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 4924c05e8528ff89c0f0035da8f70dea8ae0b12735e4176815037ae2e2f76dd6
MD5 343d4b66cc4c48105877332c24d80a83
BLAKE2b-256 1cd82847ebbb3024104a8ec143eca1a4e499a5227c47cd3a74eb16d3ed10fbbb

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