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

Uploaded Source

Built Distribution

prawcore-0.0.4-py2.py3-none-any.whl (11.6 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

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

File hashes

Hashes for prawcore-0.0.4.tar.gz
Algorithm Hash digest
SHA256 8e4b00d30cf1131cae94b0fd8fea8e1a6823360e36df5b5728be86ab0d6ca5d2
MD5 a0a2adb37ea1f7e6480770b2f4ca605c
BLAKE2b-256 523527b42c60a60625832a55963976befdc075cb91ba850835ba3d1c2e651cd9

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for prawcore-0.0.4-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 7583d13c69559789c307edf61539ccffd025b2b0635efab16ea0d537cdf22478
MD5 e540553d954132b892227e6e18d3336e
BLAKE2b-256 4fc96e87a6e40a34de7b90aac42e73a1579ba30c404defb91e0880ce8d267c5b

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