Skip to main content

Asynchronous Python Reddit API Wrapper.

Project description

Latest Async PRAW Version Supported Python Versions PyPI - Downloads - Monthly GitHub Actions Status Coveralls Coverage OpenSSF Scorecard Contributor Covenant pre-commit Black code style

Async PRAW, an abbreviation for “Asynchronous Python Reddit API Wrapper”, is a Python package that allows for simple access to Reddit’s API. Async PRAW aims to be easy to use and internally follows all of Reddit’s API rules. With Async PRAW there’s no need to introduce sleep calls in your code. Give your client an appropriate user agent and you’re set.

Installation

Async PRAW is supported on Python 3.8+. The recommended way to install Async PRAW is via pip.

pip install asyncpraw

To install the latest development version of Async PRAW run the following instead:

pip install --upgrade https://github.com/praw-dev/asyncpraw/archive/master.zip

For instructions on installing Python and pip see “The Hitchhiker’s Guide to Python” Installation Guides.

Quickstart

Assuming you already have a credentials for a script-type OAuth application you can instantiate an instance of Async PRAW like so:

import asyncpraw

reddit = asyncpraw.Reddit(
    client_id="CLIENT_ID",
    client_secret="CLIENT_SECRET",
    password="PASSWORD",
    user_agent="USERAGENT",
    username="USERNAME",
)

With the reddit instance you can then interact with Reddit:

# Create a submission to r/test
subreddit = await reddit.subreddit("test")
await subreddit.submit("Test Submission", url="https://reddit.com")

# Comment on a known submission
submission = await reddit.submission(
    url="https://www.reddit.com/comments/5e1az9", fetch=False
)
await submission.reply("Super rad!")

# Reply to the first comment of a weekly top thread of a moderated community
subreddit = await reddit.subreddit("mod")
async for submission in subreddit.top(time_filter="week"):
    comments = await submission.comments()
    await comments[0].reply("An automated reply")

# Output score for the first 256 items on the frontpage
async for submission in reddit.front.hot(limit=256):
    print(submission.score)

# Obtain the moderator listing for r/test
subreddit = await reddit.subreddit("test")
async for moderator in subreddit.moderator:
    print(moderator)

Please see Async PRAW’s documentation for more examples of what you can do with Async PRAW.

Async PRAW Discussion and Support

For those new to Python, or would otherwise consider themselves a Python beginner, please consider asking questions on the r/learnpython subreddit. There are wonderful people there who can help with general Python and simple Async PRAW related questions.

Otherwise, there are a few official places to ask questions about Async PRAW:

r/redditdev is the best place on Reddit to ask Async PRAW related questions. This subreddit is for all Reddit API related discussion so please tag submissions with [Async PRAW]. Please perform a search on the subreddit first to see if anyone has similar questions.

Real-time chat can be conducted via the PRAW Slack Organization (please create an issue if that invite link has expired).

Please do not directly message any of the contributors via Reddit, email, or Slack unless they have indicated otherwise. We strongly encourage everyone to help others with their questions.

Please file bugs and feature requests as issues on GitHub after first searching to ensure a similar issue was not already filed. If such an issue already exists please give it a thumbs up reaction. Comments to issues containing additional information are certainly welcome.

Documentation

Async PRAW’s documentation is located at https://asyncpraw.readthedocs.io/.

History

February 2019: Joel forked PRAW and began work on Async PRAW, an asynchronous compatible version of PRAW.

July 2020: Async PRAW was moved into the praw-dev namespace.

License

Async PRAW’s source (v7.1.1+) is provided under the Simplified BSD License.

  • Copyright ©, 2020, Joel Payne

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

asyncpraw-7.8.1.tar.gz (159.0 kB view details)

Uploaded Source

Built Distribution

asyncpraw-7.8.1-py3-none-any.whl (196.4 kB view details)

Uploaded Python 3

File details

Details for the file asyncpraw-7.8.1.tar.gz.

File metadata

  • Download URL: asyncpraw-7.8.1.tar.gz
  • Upload date:
  • Size: 159.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.0.1 CPython/3.12.8

File hashes

Hashes for asyncpraw-7.8.1.tar.gz
Algorithm Hash digest
SHA256 6fc50e3976ae106ef6190dbcca3b1b4050de7da5644adc50851ae6487679206f
MD5 91acb571f4a5840c25d70ecc97a903f3
BLAKE2b-256 bedff5dad426f02a6f0b3ad3c0b028ae2ecda80a05a90237c99b33583d1a1370

See more details on using hashes here.

Provenance

The following attestation bundles were made for asyncpraw-7.8.1.tar.gz:

Publisher: pypi.yml on praw-dev/asyncpraw

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file asyncpraw-7.8.1-py3-none-any.whl.

File metadata

  • Download URL: asyncpraw-7.8.1-py3-none-any.whl
  • Upload date:
  • Size: 196.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.0.1 CPython/3.12.8

File hashes

Hashes for asyncpraw-7.8.1-py3-none-any.whl
Algorithm Hash digest
SHA256 8b960dd0ab404e876b8a4eb3752a3706048a9da8fb0503018b82437d973651ba
MD5 3a57ddd18c3d7a29fc1862ed5e390198
BLAKE2b-256 8d4565671411cfaf816e4ca60b3417e79b03c98edebbe6b157dc79063f8a469b

See more details on using hashes here.

Provenance

The following attestation bundles were made for asyncpraw-7.8.1-py3-none-any.whl:

Publisher: pypi.yml on praw-dev/asyncpraw

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page