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

prawcore is a low-level communication layer used by 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-1.4.0.tar.gz (1.1 MB view details)

Uploaded Source

Built Distribution

prawcore-1.4.0-py3-none-any.whl (15.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: prawcore-1.4.0.tar.gz
  • Upload date:
  • Size: 1.1 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.8.0 tqdm/4.43.0 CPython/3.8.1

File hashes

Hashes for prawcore-1.4.0.tar.gz
Algorithm Hash digest
SHA256 cf71388d869becbcbdfd90258b19d2173c197a457f2dd0bef0566b6cfb9b95a1
MD5 81f41b40ab208a526ccb0449abd40bab
BLAKE2b-256 14cff86e83e07ac990e6c60de6216d21b68ba6191f19bad38f2be65ce87dbc82

See more details on using hashes here.

Provenance

File details

Details for the file prawcore-1.4.0-py3-none-any.whl.

File metadata

  • Download URL: prawcore-1.4.0-py3-none-any.whl
  • Upload date:
  • Size: 15.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.8.0 tqdm/4.43.0 CPython/3.8.1

File hashes

Hashes for prawcore-1.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 4c372183f1926efe8914476864705fa84234a9ca158f32046962788d6129a518
MD5 c1f74f85df8a852b4840bebf6320b904
BLAKE2b-256 6189651078078f089c182164efd10d45d3b709b46e4e40b47e63759e76349dc1

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