v0.10.1

Version 0.10.1 (October 17th, 2023)

Fix

• ⚠️ (Breaking) Fix metric_id param to correct group_id name in bavapi.brand_metric_groups top level function.

Internal

• 🔒 Renamed reference module as private. This will remove it from the code reference docs.
• ♻️ Set new dependency minimum versions for compatibility.

Docs

• 🎉 Code reference section now directs to the sync documentation by default.
• 📓 More documentation for the sync and client modules.
• 📓 Added more clarity around expected environment variables when storing API keys. bavapi will always look for an API key in the BAV_API_KEY environment variable.
• ⚙️ Refactored code reference generation to support renaming of reference module.

v0.10.0

Version 0.10.0 (October 16th, 2023)

Feature

• 🚀 The following endpoints have been fully implmented with type hints and validation:
  • brand-metrics
  • brand-metric-groups
  • categories
  • collections
  • sectors

Docs

• 📓 Documentation for newly supported endpoints.
• 📓 Documented the use of "no_default" as the include value for brandscape_data and categories functions/methods.

Internal

• ⚙️ Generalized internal _default_includes function to be able to reuse it with the categories endpoint.
• 🐛 nox session docs_build_and_serve will now rebase local branch if local version data is not synced with GitHub.

v0.9.0

Version 0.9.0 (October 11th, 2023)

Feature

• 🚀 Official support for Python 3.12.
• ⌚ Added ability to show/hide progress bar when making requests with the verbose parameter. This is available for all top-level endpoint functions and when creating an instance of bavapi.Client. To hide the progress bar, set verbose to False (by default True).

Docs

• ♻️ Added a section to the Usage Tips page explaining how to retry failed requests when an SSL exception is raised.
• 🐛 Fix absolute/relative documentation links in the GitHub CONTRIBUTING.md file and the synced docs version.
• 📓 Added documentation for changing the User Agent for HTTP requests.
• 🐛 Fix incorrect code example in the brandscape-data endpoint page.
• 📓 Added explicit documentation about which filters are available in top-level functions and methods to all endpoint pages.

Internal

• ⚠️ Fix deprecation warning due to timezone-aware datetime usage when generating reference classes in Python 3.12.

CI

• ⬆️ Upgraded nox GitHub Action versions.
• 🚀 Added Python 3.12 to GitHub Actions CI/testing.

Typing

• ✅ Enabled support for PEP 692 TypedDict kwargs via Unpack on all endpoint functions and methods.

Dependencies

• ⬆️ Updated minimum required version of typing-extensions for Python versions below 3.12.

v0.8.1

Version 0.8.1 (September 29th, 2023)

Performance

• 🚀 Improved response parsing performance by ~4x (about 0.6 seconds faster per Fount query).

Fix

• 🐛 Fix required filters in brandscape_data functions and methods.
• 🧹 Remove buried print statement in response flattening logic.

Docs

• 📓 Fixed and clarified required filters in brandscape_data functions and methods.

Internal

• 🔒 Renamed jupyter compatibility module as private. This will remove it from the code reference docs.

What's Changed

• Fix: Parsing performance and filter bugs by @nachomaiz in #14

Full Changelog: v0.8.0...v0.8.1

v0.8.0

Version 0.8.0 (September 14th, 2023)

Feature

• 🚀 It is now possible to set a timeout parameter from top-level sync endpoint functions.
• 🕵️‍♀️ It is now possible to set a user_agent parameter when creating a bavapi.Client instance.

Fix

• 🧪 Fixed bavapi-gen-refs command tests overwriting reference files.

Internal

• 🕵️‍♂️ 'BAVAPI SDK Python' is now the default User-Agent for bavapi.

Docs

• 📓 Documentation for timeout usage.
• 🚀 Automatically sync top level CONTRIBUTING.md file with the docs version.

CI

• ⚙️ Removed end-to-end tests from CI pipeline due to various issues. They will have to be run manually in the near future.

v0.7.0

Version 0.7

Version 0.7.0 (August 22nd, 2023)

Feature

• 🚀 It is now possible to specify a Fount token with -t/--token when generating reference files via the bavapi-gen-refs command.

Fix

• 🐛 bavapi-gen-refs would not run if python-dotenv was not installed. Now it will require an explicit token with -t/--token or, if dotenv is not installed, will prompt the user to install it and set the right environment variables.

Docs

• 🐛 Fixed some links not pointing to the correct documentation pages.
• 💡 Added a "Usage Tips" section describing how to save queries for later use.

CI

• 🚀 Set up automatic building of docs using mike and Github Actions.
• 🐛 Fix deploy_docs nox session.

v0.6.1

Version 0.6.1 (July 19th, 2023)

Fix

• 🐛 Fix metric_keys incorrectly categorized as a filter instead of a top-level parameter within the Query class.

Internal

• 🔧 Changed the custom IntEnum implementation to not override the standard lib's IntEnum.__str__.
• 🔨 Added nox session for deploying docs.

Tests

• 🧪 Added tests for checking that filters and parameters are assigned correctly in Client methods.

Docs

• 📓 Added warning about potential SSL errors outside of bavapi when using the Fount API.

What's Changed

• Fix metric_keys as a top-level query parameter by @nachomaiz in #6
• Don't override IntEnum.__str__ method by @nachomaiz in #7
• Updated docs by @nachomaiz in #8

Full Changelog: v0.6.0...v0.6.1

v0.6.0

Version 0.6.0 (July 13th, 2023)

Internal

• 🚀 Upgraded pydantic to v2. Use bavapi v0.5 for compatibility with pydantic v1.

Typing

• 🐛 Fixed use of type in type hints not compatible with Python. 3.8
• 🧹 Cleaned up type hints in tests.

v0.5.0

What's Changed

• Enabled Python 3.8 Support & Docs by @nachomaiz in #4

Full Changelog: v0.4.1...v0.5.0-cd1

v0.4.1

What's Changed

• Fix Type Hint Issue with Studies methods by @nachomaiz in #3

Full Changelog: v0.4.0...v0.4.1