Skip to main content

Low-level communication layer for PRAW 4+.

Project description

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

Notice: This package is in development and should not be used until this notice is removed.

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. 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.Authenticator(
    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.0.11.tar.gz (8.1 kB view details)

Uploaded Source

Built Distribution

prawcore-0.0.11-py2.py3-none-any.whl (12.2 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

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

File hashes

Hashes for prawcore-0.0.11.tar.gz
Algorithm Hash digest
SHA256 96d8ed92894b230b674fd2f910fe6eb9b4c71bee69fe32f7d869dbbf47d0d931
MD5 b595ddf641e0d5049c7a4369fbbff4e9
BLAKE2b-256 f7c636d8dd3b1b863a63915fb0d31217f4bc391486ab4c1076b5942f738f6117

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for prawcore-0.0.11-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 99286f5b7492886836bb15c86bc51d61516d10a12f5473f522e1a458c40662b8
MD5 ee62ef65d2792ef35da2e74902124bc7
BLAKE2b-256 b8223c9fdae3cc20f81be5ce282ae3c44da8f26b6e858713d57bcbd0e4fc4f11

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