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

Uploaded Source

Built Distribution

prawcore-0.0.13-py2.py3-none-any.whl (12.3 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

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

File hashes

Hashes for prawcore-0.0.13.tar.gz
Algorithm Hash digest
SHA256 3d7f0391e6be8266ec695809340d4fd45476967517d60d35d5e89d47aabb6c71
MD5 3d2d12c539b65d37c1b1ad57378620a1
BLAKE2b-256 7e0fcbc4fa793ce0bf0b60db0c04c4ffb05d98fadb207ad22c6c31047a3a75de

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for prawcore-0.0.13-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 84c3fc45b83169c141a6d5ce54205472f80d4ab61dc8df97a21de65e49457ad3
MD5 4703c46b9c31dbd6b33ca2f9216c9b34
BLAKE2b-256 a2ad8e7f36f4626ffda1346c148653b6e61606658f9fb62d9f9b7b54aca02f12

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