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

Uploaded Source

Built Distribution

prawcore-0.2.1-py2.py3-none-any.whl (13.9 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

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

File hashes

Hashes for prawcore-0.2.1.tar.gz
Algorithm Hash digest
SHA256 e5be45cb3f4336dcbae7d6f6c9bcbae420a4c831fa995994ce6bd059245e42f2
MD5 05868e4a848af158abec729a10b344f9
BLAKE2b-256 81a7b4d925829f6bd0c1a5fc85db29a7797db66025396aa5b8837c3033851ea1

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for prawcore-0.2.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 91872c7704f3917547646f5478424c1b21e8832659098298300f60b01690e647
MD5 f0b35b0818dc7163af686320c6f412cf
BLAKE2b-256 c7e96b34e4da7e153cb0bf3c804e017f18cdee175e8a4330539f3729fb4ca88a

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