v1.0.0

1.0.0 (2024-01-04)

Feature

• 🎉 Added five new endpoints to bavapi with accompanying FountFilters classes:
  • cities
  • companies
  • countries
  • regions
  • years

Changes

• ♻️ Initial handshake API request will now be retried on SSL errors.

Docs

• 🧹 Reordered some sections in the Basic usage and Advanced usage sections of the documentation.
• 🧹 Updated and standardized Jupyter notebook demo.
• 🧹 Clarified when a query is considered to be a single-page query in the bavapi.Query.is_single_page docstring.
• 🧹 Fixed some minor errors in bavapi.Client method docstrings.
• 🎉 Added examples of the batch logic in the Jupyter demo notebook.
• 🧹 Repurposed the getting started section on reference classes as the primary documentation page for the references functionality, rather than keeping a section in Basic usage.
• ✨ Changed Release notes dates to ISO-8601 format.

Internal

• ℹ️ Cleaned up and added comments to documentation scripts.
• ✨ Removed tqdm as a dependency from the batching logic.
• ℹ️ Added comments to nox session for deploying the docs.
• 🧹 Simplified some logic in Query.ensure.
• 🎉 Added support for specifying exceptions to retry on for aretry internal function.

CI

• ♻️ CI won't run unless a package or test file is changed, or the CI action file is changed.
• ✨ Added manual trigger to documentation so deploying fixes to the docs doesn't require a version change.