Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ repos:
files: ^(.*\.toml)$

- repo: https://github.com/astral-sh/ruff-pre-commit
rev: v0.13.3
rev: v0.14.6
hooks:
- id: ruff
args: [ --exit-non-zero-on-fix, --fix ]
Expand All @@ -35,4 +35,4 @@ repos:
hooks:
- id: docstrfmt
require_serial: true
rev: v1.11.1
rev: v2.0.0
10 changes: 6 additions & 4 deletions AUTHORS.rst
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
Maintainers
===========
#############
Maintainers
#############

- Joel Payne <lilspazjoekp@gmail.com> `@LilSpazJoekp <https://github.com/LilSpazJoekp>`_

Contributors
============
##############
Contributors
##############

- nmtake `@nmtake <https://github.com/nmtake>`_
- elnuno `@elnuno <https://github.com/elnuno>`_
Expand Down
80 changes: 48 additions & 32 deletions CHANGES.rst
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
Change Log
==========
############
Change Log
############

asyncprawcore follows `semantic versioning <https://semver.org/>`_.

Unreleased
----------
************
Unreleased
************

**Changed**

Expand All @@ -13,22 +15,25 @@ Unreleased
- Pass ``files`` to ``aiohttp.ClientSession.request()`` in ``Requestor.request()``
correctly again.

3.0.2 (2025/08/06)
------------------
********************
3.0.2 (2025/08/06)
********************

**Changed**

- Improved type hinting.

3.0.1 (2025/08/02)
------------------
********************
3.0.1 (2025/08/02)
********************

**Fixed**

- Increase half-second delay introduced in ``3.0.0`` to a full second delay.

3.0.0 (2025/08/02)
------------------
********************
3.0.0 (2025/08/02)
********************

**Changed**

Expand All @@ -47,8 +52,9 @@ Unreleased

- Remove :class:`RateLimiter` attribute ``reset_timestamp``.

2.4.0 (2023/11/27)
------------------
********************
2.4.0 (2023/11/27)
********************

**Changed**

Expand All @@ -57,8 +63,9 @@ Unreleased
- Updated rate limit algorithm to better handle Reddit's new rate limits.
- Drop support for Python 3.7, which was end-of-life on 2023-06-27.

2.3.0 (2021/07/27)
------------------
********************
2.3.0 (2021/07/27)
********************

**Added**

Expand All @@ -69,15 +76,17 @@ Unreleased
scope of access requests.
- Retry 408 "Request Timeout" HTTP responses.

2.2.1 (2021/07/06)
------------------
********************
2.2.1 (2021/07/06)
********************

**Changed**

- Cast non-string objects to string when preprocessing ``data`` and ``params``.

2.2.0 (2021/06/15)
------------------
********************
2.2.0 (2021/06/15)
********************

**Added**

Expand All @@ -88,8 +97,9 @@ Unreleased
- The expected HTTP response status code for a request made with the proper credentials
to api/v1/revoke_token has been changed from 204 to 200.

2.1.0 (2021/06/15)
------------------
********************
2.1.0 (2021/06/15)
********************

**Added**

Expand All @@ -102,8 +112,9 @@ Unreleased

- Fix ``RuntimeWarning`` when executing pre/post refresh token callbacks.

2.0.0 (2021-02-23)
------------------
********************
2.0.0 (2021-02-23)
********************

**Added**

Expand All @@ -119,15 +130,17 @@ Unreleased
- The ``refresh_token`` argument to :class:`Authorizer` must now be passed by keyword,
and cannot be passed as a positional argument.

1.5.1 (2021-01-25)
------------------
********************
1.5.1 (2021-01-25)
********************

**Changed**

- Improved preprocessing for ``data`` and ``params`` in ``Session.request()``.

1.5.0 (2020-09-28)
------------------
********************
1.5.0 (2020-09-28)
********************

**Added**

Expand All @@ -153,8 +166,9 @@ Unreleased
``asyncprawcore.Session.request()`` are now casted to a string as
``aiohttp.ClientSession.request()`` does not accept boolean values in ``params``.

1.4.0.post2 (2020-07-12)
------------------------
**************************
1.4.0.post2 (2020-07-12)
**************************

**Fixed**

Expand All @@ -163,16 +177,18 @@ Unreleased
- Fixed ``SpecialException`` not able to get ``response.json()`` since it is a
coroutine.

1.4.0.post1 (2020-07-03)
------------------------
**************************
1.4.0.post1 (2020-07-03)
**************************

**Fixed**

- Documentation errors.
- ``authorize_url`` will correctly return a ``str`` instead of ``yarl.URL()``.

1.4.0 (2020-06-20)
------------------
********************
1.4.0 (2020-06-20)
********************

- Converted from ``requests`` to ``aiohttp`` for asynchronous operation.
- Updated upto version 1.4.0 of prawcore.
Expand Down
24 changes: 14 additions & 10 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
.. _main_page:

asyncprawcore
=============
###############
asyncprawcore
###############

.. image:: https://img.shields.io/pypi/v/asyncprawcore.svg
:alt: Latest asyncprawcore Version
Expand Down Expand Up @@ -33,17 +34,19 @@ asyncprawcore

asyncprawcore is a low-level communication layer used by Async PRAW 7+.

Installation
------------
**************
Installation
**************

Install asyncprawcore using ``pip`` via:

.. code-block:: console

pip install asyncprawcore

Execution Example
-----------------
*******************
Execution Example
*******************

The following example demonstrates how to use asyncprawcore to obtain the list of
trophies for a given user using the script-app type. This example assumes you have the
Expand Down Expand Up @@ -83,8 +86,9 @@ Save the above as ``trophies.py`` and then execute via:
Additional examples can be found at:
https://github.com/praw-dev/asyncprawcore/tree/main/examples

Depending on asyncprawcore
--------------------------
****************************
Depending on asyncprawcore
****************************

asyncprawcore follows `semantic versioning <https://semver.org/>`_ with the exception
that deprecations will not be preceded by a minor release. In essence, expect only major
Expand All @@ -95,14 +99,14 @@ version of asyncprawcore your package requires, but to also limit the major vers
Below are two examples of how you may want to specify your asyncprawcore dependency:

setup.py
~~~~~~~~
========

.. code-block:: python

setup(..., install_requires=["asyncprawcore >=0.1, <1"], ...)

requirements.txt
~~~~~~~~~~~~~~~~
================

.. code-block:: text

Expand Down
Loading