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

Uploaded Source

Built Distribution

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

Uploaded Python 2 Python 3

File details

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

File metadata

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

File hashes

Hashes for prawcore-0.0.7.tar.gz
Algorithm Hash digest
SHA256 8202c1dc70ecee12e1e4fbc1466c6bda4313616a281ffc15118faf7debbf2e6e
MD5 74f00822c62d08a93af45ab343f0c8ea
BLAKE2b-256 39f39c506f23ca1f0f19c0e632bf76324a8f949981a316221536e178035a1fef

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for prawcore-0.0.7-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 189dddb7bb860304676feabd704f952020204d8cfbab068390553ae254dd16ad
MD5 1ee3c6282f5e7908e0c53b35146c6a15
BLAKE2b-256 9eb96a934a7421137324a484a64f6ea57f907590326a9ec50b23ff62bc4d6b83

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