Async PRAW: The Asynchronous Python Reddit API Wrapper
======================================================
.. image:: https://img.shields.io/pypi/v/asyncpraw.svg
:alt: Latest Async PRAW Version
:target: https://pypi.python.org/pypi/asyncpraw
.. image:: https://img.shields.io/pypi/pyversions/asyncpraw
:alt: Supported Python Versions
:target: https://pypi.python.org/pypi/asyncpraw
.. image:: https://img.shields.io/pypi/dm/asyncpraw
:alt: PyPI - Downloads - Monthly
:target: https://pypi.python.org/pypi/asyncpraw
.. image:: https://github.com/praw-dev/asyncpraw/actions/workflows/ci.yml/badge.svg?event=push
:alt: GitHub Actions Status
:target: https://github.com/praw-dev/asyncpraw/actions/workflows/ci.yml
.. image:: https://coveralls.io/repos/github/praw-dev/asyncpraw/badge.svg
:alt: Coveralls Coverage
:target: https://coveralls.io/github/praw-dev/asyncpraw?branch=master
.. image:: https://api.securityscorecards.dev/projects/github.com/praw-dev/asyncpraw/badge
:alt: OpenSSF Scorecard
:target: https://api.securityscorecards.dev/projects/github.com/praw-dev/asyncpraw
.. image:: https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg
:alt: Contributor Covenant
:target: https://github.com/praw-dev/.github/blob/main/CODE_OF_CONDUCT.md
.. image:: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white
:alt: pre-commit
:target: https://github.com/pre-commit/pre-commit
.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
:alt: Black code style
:target: https://github.com/psf/black
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
<https://github.com/reddit/reddit/wiki/API>`_. 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:
Installation
------------
Async PRAW is supported on Python 3.8+. The recommended way to install Async PRAW is via
`pip <https://pypi.python.org/pypi/pip>`_.
.. code-block:: bash
pip install asyncpraw
To install the latest development version of Async PRAW run the following instead:
.. code-block:: bash
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 <https://docs.python-guide.org/en/latest/starting/installation/>`_.
Quickstart
----------
Assuming you already have a credentials for a script-type OAuth application you can
instantiate an instance of Async PRAW like so:
.. code-block:: python
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:
.. code-block:: python
# 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 <https://asyncpraw.readthedocs.io/>`_ 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
<https://www.reddit.com/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 <https://www.reddit.com/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
<https://join.slack.com/t/praw/shared_invite/enQtOTUwMDcxOTQ0NzY5LWVkMGQ3ZDk5YmQ5MDEwYTZmMmJkMTJkNjBkNTY3OTU0Y2E2NGRlY2ZhZTAzMWZmMWRiMTMwYjdjODkxOGYyZjY>`_
(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
<https://github.com/praw-dev/asyncpraw/issues>`_ 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.
.. note::
This project is released with a `Contributor Code of Conduct
<https://github.com/praw-dev/.github/blob/main/CODE_OF_CONDUCT.md>`_. By
participating in this project you agree to abide by its terms.
Documentation
-------------
Async PRAW's documentation is located at https://asyncpraw.readthedocs.io/.
History
-------
`February 2019
<https://github.com/praw-dev/asyncpraw/commit/55480eb3d59dc7bc3d1480d83b98c95effc77181>`_:
Joel forked PRAW and began work on Async PRAW, an asynchronous compatible version of
PRAW.
`July 2020
<https://github.com/praw-dev/asyncpraw/commit/b8b8a4bf3618639968e8be379e85e2ff84f2307a>`_:
Async PRAW was moved into the praw-dev namespace.
License
-------
Async PRAW's source (v7.1.1+) is provided under the `Simplified BSD License
<https://github.com/praw-dev/asyncpraw/blob/30796acc29b4ba2335cf0eab414477702c29452f/LICENSE.txt>`_.
- Copyright ©, 2020, Joel Payne
Raw data
{
"_id": null,
"home_page": null,
"name": "asyncpraw",
"maintainer": null,
"docs_url": null,
"requires_python": "~=3.8",
"maintainer_email": "Joel Payne <lilspazjoekp@gmail.com>",
"keywords": "reddit, api, wrapper, asyncpraw, praw, async, asynchronous",
"author": null,
"author_email": "Joel Payne <lilspazjoekp@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/e0/90/a67f83d8b62f84d2002dee68422d42843384bdfc06d3ac866fe516f00d3a/asyncpraw-7.8.0.tar.gz",
"platform": null,
"description": "Async PRAW: The Asynchronous Python Reddit API Wrapper\n======================================================\n\n.. image:: https://img.shields.io/pypi/v/asyncpraw.svg\n :alt: Latest Async PRAW Version\n :target: https://pypi.python.org/pypi/asyncpraw\n\n.. image:: https://img.shields.io/pypi/pyversions/asyncpraw\n :alt: Supported Python Versions\n :target: https://pypi.python.org/pypi/asyncpraw\n\n.. image:: https://img.shields.io/pypi/dm/asyncpraw\n :alt: PyPI - Downloads - Monthly\n :target: https://pypi.python.org/pypi/asyncpraw\n\n.. image:: https://github.com/praw-dev/asyncpraw/actions/workflows/ci.yml/badge.svg?event=push\n :alt: GitHub Actions Status\n :target: https://github.com/praw-dev/asyncpraw/actions/workflows/ci.yml\n\n.. image:: https://coveralls.io/repos/github/praw-dev/asyncpraw/badge.svg\n :alt: Coveralls Coverage\n :target: https://coveralls.io/github/praw-dev/asyncpraw?branch=master\n\n.. image:: https://api.securityscorecards.dev/projects/github.com/praw-dev/asyncpraw/badge\n :alt: OpenSSF Scorecard\n :target: https://api.securityscorecards.dev/projects/github.com/praw-dev/asyncpraw\n\n.. image:: https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg\n :alt: Contributor Covenant\n :target: https://github.com/praw-dev/.github/blob/main/CODE_OF_CONDUCT.md\n\n.. image:: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white\n :alt: pre-commit\n :target: https://github.com/pre-commit/pre-commit\n\n.. image:: https://img.shields.io/badge/code%20style-black-000000.svg\n :alt: Black code style\n :target: https://github.com/psf/black\n\nAsync PRAW, an abbreviation for \"Asynchronous Python Reddit API Wrapper\", is a Python\npackage that allows for simple access to Reddit's API. Async PRAW aims to be easy to use\nand internally follows all of `Reddit's API rules\n<https://github.com/reddit/reddit/wiki/API>`_. With Async PRAW there's no need to\nintroduce ``sleep`` calls in your code. Give your client an appropriate user agent and\nyou're set.\n\n.. _installation:\n\nInstallation\n------------\n\nAsync PRAW is supported on Python 3.8+. The recommended way to install Async PRAW is via\n`pip <https://pypi.python.org/pypi/pip>`_.\n\n.. code-block:: bash\n\n pip install asyncpraw\n\nTo install the latest development version of Async PRAW run the following instead:\n\n.. code-block:: bash\n\n pip install --upgrade https://github.com/praw-dev/asyncpraw/archive/master.zip\n\nFor instructions on installing Python and pip see \"The Hitchhiker's Guide to Python\"\n`Installation Guides <https://docs.python-guide.org/en/latest/starting/installation/>`_.\n\nQuickstart\n----------\n\nAssuming you already have a credentials for a script-type OAuth application you can\ninstantiate an instance of Async PRAW like so:\n\n.. code-block:: python\n\n import asyncpraw\n\n reddit = asyncpraw.Reddit(\n client_id=\"CLIENT_ID\",\n client_secret=\"CLIENT_SECRET\",\n password=\"PASSWORD\",\n user_agent=\"USERAGENT\",\n username=\"USERNAME\",\n )\n\nWith the ``reddit`` instance you can then interact with Reddit:\n\n.. code-block:: python\n\n # Create a submission to r/test\n subreddit = await reddit.subreddit(\"test\")\n await subreddit.submit(\"Test Submission\", url=\"https://reddit.com\")\n\n # Comment on a known submission\n submission = await reddit.submission(\n url=\"https://www.reddit.com/comments/5e1az9\", fetch=False\n )\n await submission.reply(\"Super rad!\")\n\n # Reply to the first comment of a weekly top thread of a moderated community\n subreddit = await reddit.subreddit(\"mod\")\n async for submission in subreddit.top(time_filter=\"week\"):\n comments = await submission.comments()\n await comments[0].reply(\"An automated reply\")\n\n # Output score for the first 256 items on the frontpage\n async for submission in reddit.front.hot(limit=256):\n print(submission.score)\n\n # Obtain the moderator listing for r/test\n subreddit = await reddit.subreddit(\"test\")\n async for moderator in subreddit.moderator:\n print(moderator)\n\nPlease see Async PRAW's `documentation <https://asyncpraw.readthedocs.io/>`_ for more\nexamples of what you can do with Async PRAW.\n\nAsync PRAW Discussion and Support\n---------------------------------\n\nFor those new to Python, or would otherwise consider themselves a Python beginner,\nplease consider asking questions on the `r/learnpython\n<https://www.reddit.com/r/learnpython>`_ subreddit. There are wonderful people there who\ncan help with general Python and simple Async PRAW related questions.\n\nOtherwise, there are a few official places to ask questions about Async PRAW:\n\n`r/redditdev <https://www.reddit.com/r/redditdev>`_ is the best place on Reddit to ask\nAsync PRAW related questions. This subreddit is for all Reddit API related discussion so\nplease tag submissions with *[Async PRAW]*. Please perform a search on the subreddit\nfirst to see if anyone has similar questions.\n\nReal-time chat can be conducted via the `PRAW Slack Organization\n<https://join.slack.com/t/praw/shared_invite/enQtOTUwMDcxOTQ0NzY5LWVkMGQ3ZDk5YmQ5MDEwYTZmMmJkMTJkNjBkNTY3OTU0Y2E2NGRlY2ZhZTAzMWZmMWRiMTMwYjdjODkxOGYyZjY>`_\n(please create an issue if that invite link has expired).\n\nPlease do not directly message any of the contributors via Reddit, email, or Slack\nunless they have indicated otherwise. We strongly encourage everyone to help others with\ntheir questions.\n\nPlease file bugs and feature requests as issues on `GitHub\n<https://github.com/praw-dev/asyncpraw/issues>`_ after first searching to ensure a\nsimilar issue was not already filed. If such an issue already exists please give it a\nthumbs up reaction. Comments to issues containing additional information are certainly\nwelcome.\n\n.. note::\n\n This project is released with a `Contributor Code of Conduct\n <https://github.com/praw-dev/.github/blob/main/CODE_OF_CONDUCT.md>`_. By\n participating in this project you agree to abide by its terms.\n\nDocumentation\n-------------\n\nAsync PRAW's documentation is located at https://asyncpraw.readthedocs.io/.\n\nHistory\n-------\n\n`February 2019\n<https://github.com/praw-dev/asyncpraw/commit/55480eb3d59dc7bc3d1480d83b98c95effc77181>`_:\nJoel forked PRAW and began work on Async PRAW, an asynchronous compatible version of\nPRAW.\n\n`July 2020\n<https://github.com/praw-dev/asyncpraw/commit/b8b8a4bf3618639968e8be379e85e2ff84f2307a>`_:\nAsync PRAW was moved into the praw-dev namespace.\n\nLicense\n-------\n\nAsync PRAW's source (v7.1.1+) is provided under the `Simplified BSD License\n<https://github.com/praw-dev/asyncpraw/blob/30796acc29b4ba2335cf0eab414477702c29452f/LICENSE.txt>`_.\n\n- Copyright \u00a9, 2020, Joel Payne\n\n",
"bugtrack_url": null,
"license": null,
"summary": "Asynchronous Python Reddit API Wrapper.",
"version": "7.8.0",
"project_urls": {
"Change Log": "https://asyncpraw.readthedocs.io/en/latest/package_info/change_log.html",
"Documentation": "https://asyncpraw.readthedocs.io/",
"Issue Tracker": "https://github.com/praw-dev/asyncpraw/issues",
"Source Code": "https://github.com/praw-dev/asyncpraw"
},
"split_keywords": [
"reddit",
" api",
" wrapper",
" asyncpraw",
" praw",
" async",
" asynchronous"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b4f4c7243176673ceda9cc85c60055c679233906be214b2929b30aaaba4c3c1b",
"md5": "d5bbf5f67b6600c681044cad2084d3ac",
"sha256": "453f01422f114017aba9c843c8a84c671e00c752f94900d9ae2f7c224b025f76"
},
"downloads": -1,
"filename": "asyncpraw-7.8.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d5bbf5f67b6600c681044cad2084d3ac",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "~=3.8",
"size": 196435,
"upload_time": "2024-10-20T20:50:29",
"upload_time_iso_8601": "2024-10-20T20:50:29.988178Z",
"url": "https://files.pythonhosted.org/packages/b4/f4/c7243176673ceda9cc85c60055c679233906be214b2929b30aaaba4c3c1b/asyncpraw-7.8.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e090a67f83d8b62f84d2002dee68422d42843384bdfc06d3ac866fe516f00d3a",
"md5": "ecf1cd6dd772bffa7c351dbbfb0b816f",
"sha256": "a844409461ef19d45148eca15c434aa44048ec0d08e5cb3a282e34251ed20d86"
},
"downloads": -1,
"filename": "asyncpraw-7.8.0.tar.gz",
"has_sig": false,
"md5_digest": "ecf1cd6dd772bffa7c351dbbfb0b816f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "~=3.8",
"size": 158982,
"upload_time": "2024-10-20T20:50:31",
"upload_time_iso_8601": "2024-10-20T20:50:31.479639Z",
"url": "https://files.pythonhosted.org/packages/e0/90/a67f83d8b62f84d2002dee68422d42843384bdfc06d3ac866fe516f00d3a/asyncpraw-7.8.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-20 20:50:31",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "praw-dev",
"github_project": "asyncpraw",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"tox": true,
"lcname": "asyncpraw"
}
JSON
