Adds a new method of pagination that might get used in more places in the future. In the mean time it's handy to have a function that implements it on the client end.
This change also includes a bit of project metadata housecleaning: removing myself as the code author. At this point, I have granted @lnxchk joint ownership over the PyPI project and documented the steps typically taken to release a new version, so it should be fully community-maintainable yet with PagerDuty still in control of the release pipeline in case something happens to me.
Changelog
**2022-02-17: Version 4.5.0**
* Add a new API generator ``iter_cursor`` to :class:`APISession` that yields results from API endpoints that support cursor-based pagination, requesting the next page of results whenever needed.
TODO
[x] Write unit test for iter_cursor
[x] Rewrite the examples that require hard-coding the API key to actually work, so they use environment variables
[x] ~Add a section with examples of endpoints that the r* methods don't support~ overlaps with the next task
[x] ~Make docs on the r* methods more concise with less fluff~ Made a new issue for this / this is out of scope
[x] ~Add a section to the docs on cursor-based pagination and distinguish between it and traditional offset-based pagination~ I want to eventually rewrite a lot of the docs and I intend on putting this into the section on pagination when I do that.
Summary
Adds a new method of pagination that might get used in more places in the future. In the mean time it's handy to have a function that implements it on the client end.
This change also includes a bit of project metadata housecleaning: removing myself as the code author. At this point, I have granted @lnxchk joint ownership over the PyPI project and documented the steps typically taken to release a new version, so it should be fully community-maintainable yet with PagerDuty still in control of the release pipeline in case something happens to me.
Changelog
TODO
iter_cursorr*methods don't support~ overlaps with the next taskr*methods more concise with less fluff~ Made a new issue for this / this is out of scope