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

Uploaded Source

Built Distribution

prawcore-0.0.3-py2.py3-none-any.whl (11.5 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

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

File hashes

Hashes for prawcore-0.0.3.tar.gz
Algorithm Hash digest
SHA256 1b357fe42a03271c0a31a34402cd4a55dc343b5565a7ca85a08b51ad911eb856
MD5 e0080d7c4f335f23554d47760b3e0082
BLAKE2b-256 551b13f6c3e63c3c7bc21a9b5636f6f6206e7c451ba1fc6476a46d8e0260f734

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for prawcore-0.0.3-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 6e5ffdbe5846e66432ea3f4badf9e371442734b4d705f7b994925cea0fd993d2
MD5 3641b04f8d66de36655dc725e75b4148
BLAKE2b-256 e45f185defbd1960b7db234a1aeccdc279a4b1127aba7b794dde75377d9b1b12

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