bavapi Roadmap

bavapi has now reached stable (v1) status

v1 Roadmap - COMPLETED

This is a non-exhaustive list of potential features & changes to bavapi before it is ready for full release:

Core tooling

• v0.6.0 pydantic V2 support
• v0.9.0 Strict mypy support with PEP 692 Unpack and TypedDict
• v0.11.0 Ability to use custom bavapi.Query objects in endpoint methods and functions
• v0.11.0 Improved importing experiece when using reference classes created via the bavapi-gen-refs command
• v0.12.0 Ability to control pagination for performing a lot of requests.

Known issues

• v0.13.0 Sporadic SSL: CERTIFICATE_VERIFY_FAILED errors when making requests to the Fount API.

Fully-supported endpoints

Eventually, the plan is to support almost all endpoints. This is the current priority list:

• v0.1.0 Brands
• v0.1.0 Brandscape Data
• v0.1.0 Studies
• v0.4.0 Audiences
• v0.10.0 Categories
• v0.10.0 Collections
• v0.10.0 Brand Metrics
• v0.10.0 Sectors
• v0.10.0 Brand Metric Groups
• v1.0.0 Cities
• v1.0.0 Companies
• v1.0.0 Countries
• v1.0.0 Regions
• v1.0.0 Years

Stretch goals

• v0.8.1 Smarter flattening of JSON responses, possibly through pandas.json_normalize.