wpp-bavapi 0.5.0

Python consumer for the WPPBAV Fount API.

BAV API Python SDK

bavapi is a Python SDK for the WPP BAV API.

It is published on PyPI as wpp-bavapi.

With bavapi you can access the full BAV data catalog, the largest and most comprehensive database of brand data in the world.

Queries are validated automatically thanks to pydantic and retrieved asynchronously via the httpx package.

For more information about the API, go to the WPPBAV Developer Hub.

Prerequisites

bavapi requires Python 3.8 or higher to run.

If you don't have Python installed, you can find it from the official website or via Anaconda.

You will also need a BAV API token. For more information, go to the Authentication section of the API documentation.

Dependencies

• httpx >= 0.20
• nest-asyncio >= 1.5.6
• pandas >= 0.16.2
• pydantic >= 1.10, < 2.0
• tqdm >= 4.62
• typing-extensions >= 3.10 for Python < 3.10

Installation

bavapi can be installed using pip:

pip install wpp-bavapi

Installing from source

To install from source, clone the GitHub repository into your local machine:

git clone https://github.com/wppbav/bavapi-sdk-python.git

Go into the cloned directory and install bavapi:

cd bavapi-sdk-python
pip install .

Usage

Once you have acquired a token, you can start using this library directly in python or in a Jupyter Notebook:

>>> import bavapi
>>> result = bavapi.brands("TOKEN", name="Swatch")  # Replace `"TOKEN"` with your BAV API token
>>> result

	sector_id	sector_name	id	name	...
0	233	Apparel & Accessories	8635	Swatch	...
...	...	...	...	...	...

Features

• Support for all endpoints in the Fount API. Extended support for the audiences, brands, brandscape-data and studies endpoints.
  • Other endpoints are available via the raw_query functions and methods.
• Validates query parameters are of the correct types.
  • Provides type hints for better IDE support.
• Retrieve multiple pages of data simultaneously.
  • Monitors and prevents exceeding API rate limit.
• Both synchronous and asynchronous APIs for accessing BAV data.

Documentation

Read more about bavapi in the documentation.

Issues

Please file an issue on GitHub here.

Contributing

Please see the Contributing section of the documentation for more information.