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

Uploaded Source

Built Distribution

prawcore-0.10.0-py2.py3-none-any.whl (14.9 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

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

File hashes

Hashes for prawcore-0.10.0.tar.gz
Algorithm Hash digest
SHA256 be3af201d24d12c6aee9bbb0dd163387f9135d00896ee1d45c589a0ecff8112b
MD5 54a47c3e2051d8f1ec7c28a6c3310a12
BLAKE2b-256 7316beba1c11e1b15a4424302b4b2040a7044ca5b08fea97714bc94d4161b34f

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for prawcore-0.10.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 4594000f0c1fe6228f61fe0f3f85785db1e3bfb845bd6dbb0e4230c46847df6f
MD5 fc538d08bae8ab6995428dcc74aa1cc2
BLAKE2b-256 d21c32284eee717468370959ed8b8f0eaa197364011b314c54a36f66fbb94e48

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