v0.12.0

0.12.0 (November 15th, 2023)

Feature

• 🎉 Added support for metric_group_keys, for use with the brandscape-data endpoint.
• 🎉 It is now possible to use page as the start page of a paginated request. Use per_page and/or max_pages to change the behavior of the pagination. More info in the Basic Usage section of the documentation.
• ✨ As a result of the new paginated behavior, it is now possible to chunk requests by setting the start and end of the request with page and per_page, respectively. See more info in the Project tips section of the documentation.

Changes

• ⚠️ Exceptions DataNotFoundError and RateLimitExceededError are now subclasses of APIError.
• 🔨 Refactored pagination logic to allow for control over the start and end of the paginated request to the Fount. Shouldn't break existing uses of page unless per_page and/or max_pages were also in use. More info in the Basic Usage section of the documentation.
• ⚙️ Query.with_page parameters are now optional and default to None.
• 🔧 Query attributes page, per_page, and max_pages must be greater than 0.
• 🛑 (BREAKING) Query.paginated parameter order has changed to make per_page optional.

Fix

• ⚙️ Various issues and inconsistencies with pagination logic.
• 🐛 Fixed per_page not applying to single page results.

Docs

• ✨ Added instructions for performing batched requests in the Project Tips section of the documentation.