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

Uploaded Source

Built Distribution

prawcore-0.4.0-py2.py3-none-any.whl (14.4 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

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

File hashes

Hashes for prawcore-0.4.0.tar.gz
Algorithm Hash digest
SHA256 6c64860561efbc4dcf72842fc464fe3380f6906e20ae30e94003fd53e1ab7815
MD5 0e83e215ebe0f19bced9ee2260889995
BLAKE2b-256 72d35aa03918614b3495ea56da65311ea33f7262bc6f7f67b6268b76be86d610

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for prawcore-0.4.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 f38fd9395262c2f04c9a4aa4e7a0576014d33221b3471cc00843ec5ea55c2d16
MD5 07ee5a4ceaa174cf3fa8c816233303bf
BLAKE2b-256 55c6d1b5573441aa8ff9842c447ddda26f7affb4df306fcb568a8d3456f3d89e

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