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

Uploaded Source

Built Distribution

prawcore-0.1.0-py2.py3-none-any.whl (12.9 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

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

File hashes

Hashes for prawcore-0.1.0.tar.gz
Algorithm Hash digest
SHA256 67fbce1f2403ec289edad8f38f11b8206c0c4f02ae3db533b5b1ba5ef10f0a4e
MD5 03871093b1b3a2dbe8ccfd472620dd30
BLAKE2b-256 9fd16787dc7a25b320e32dc0f46e4db478e174ddfb8c7e101ee25c4ba3d662c5

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for prawcore-0.1.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 2cafe50102a1fa316697582a51c48e704075afa5f5b94dbf4c57c749fd6389c8
MD5 fffab14f74d2f8cce427520ee15d1577
BLAKE2b-256 9d70bba6255f3ddc07f83f553b43375b5bd9cfdd22553074d1f0a710124a0bac

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