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

Uploaded Source

Built Distribution

prawcore-0.0.8-py2.py3-none-any.whl (12.0 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

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

File hashes

Hashes for prawcore-0.0.8.tar.gz
Algorithm Hash digest
SHA256 5553e79fca5f00a66ff78a9d91a8c505bee37a78bb731246e4edd0d973fce6bf
MD5 06bbde8abcff7663d366bc2d1cd121b6
BLAKE2b-256 0536ff259289bf7a3c9a8384e0c05c6061a44055b920df19d49f460b2de8ee97

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for prawcore-0.0.8-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 6ff86ea7c5f22a3e6e631e78fadd849e16976c7db57c43ab802bfe75b6f0c0e8
MD5 b104d8c3da1351fee3afb022683c6997
BLAKE2b-256 9bce0a01fdd37e575f13f5800b7346443ddb7eaf72ce27c6aa5a546ec515d70b

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