# BAV API Python SDK
[](https://github.com/wppbav/bavapi-sdk-python/actions/workflows/ci.yml)
[](https://github.com/wppbav/bavapi-sdk-python/actions/workflows/release.yml)
[](https://github.com/wppbav/bavapi-sdk-python/actions/workflows/docs.yml)
[](https://github.com/wppbav/bavapi-sdk-python/actions/workflows/ci.yml)
[](https://pypi.org/project/wpp-bavapi/)
[](https://pypi.org/project/wpp-bavapi/)
`bavapi` is a Python SDK for the WPP BAV API.
It is published on [PyPI](https://pypi.org/project/wpp-bavapi/) 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](https://developer.wppbav.com).
## Prerequisites
`bavapi` requires Python 3.8 or higher to run.
If you don't have Python installed, you can find it from the [official](https://www.python.org/downloads/) website or via [Anaconda](https://www.anaconda.com/).
You will also need a BAV API token. For more information, go to the [Authentication](https://developer.wppbav.com/docs/2.x/authentication) section of the API documentation.
### Dependencies
- `httpx >= 0.20`
- `nest-asyncio >= 1.5`
- `pandas >= 1.0`
- `pydantic >= 2.0`
- `tqdm >= 4.62`
- `typing-extensions >= 4.6` for Python < 3.12
## Installation
`bavapi` can be installed using `pip`:
```prompt
pip install wpp-bavapi
```
### Installing from source
To install from source, clone the GitHub repository into your local machine:
```prompt
git clone https://github.com/wppbav/bavapi-sdk-python.git
```
Go into the cloned directory and install `bavapi`:
```prompt
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:
```py
>>> 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 WPPBAV Fount API.
- Extended support for the following endpoints:
- `audiences`
- `audience-groups`
- `brand-metrics`
- `brand-metric-groups`
- `brands`
- `brandscape-data`
- `categories`
- `cities`
- `collections`
- `companies`
- `countries`
- `sectors`
- `studies`
- `years`
- Other endpoints are available via the `raw_query` functions and methods.
- Extended support for Fount API Tools/TurboPitch endpoints.
- Validates query parameters are of the correct types and provides type hints for better IDE support.
- Retrieve multiple pages of data simultaneously, monitoring and preventing exceeding API rate limit.
- Both synchronous and asynchronous APIs for accessing BAV data.
## Documentation
Read more about `bavapi` in the [documentation](https://wppbav.github.io/bavapi-sdk-python/).
## Issues
Please file an issue on GitHub [here](https://github.com/wppbav/bavapi-sdk-python/issues).
## Contributing
Please see the [Contributing](https://wppbav.github.io/bavapi-sdk-python/contributing/) section of the documentation for more information.
Raw data
{
"_id": null,
"home_page": null,
"name": "wpp-bavapi",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "wpp-bavapi, bavapi, bavgroup, bav, brandasset, brandassetvaluator, wppbav, wpp, fount",
"author": null,
"author_email": "Ignacio Maiz Vilches <ignacio.maiz@bavgroup.com>",
"download_url": "https://files.pythonhosted.org/packages/1d/ef/0ecc31672deba5d8f2f6664ca006de69d6cdfdc2abdd6197d17824e3e9eb/wpp_bavapi-1.1.0.tar.gz",
"platform": null,
"description": "# BAV API Python SDK\n\n[](https://github.com/wppbav/bavapi-sdk-python/actions/workflows/ci.yml)\n[](https://github.com/wppbav/bavapi-sdk-python/actions/workflows/release.yml)\n[](https://github.com/wppbav/bavapi-sdk-python/actions/workflows/docs.yml)\n[](https://github.com/wppbav/bavapi-sdk-python/actions/workflows/ci.yml)\n[](https://pypi.org/project/wpp-bavapi/)\n[](https://pypi.org/project/wpp-bavapi/)\n\n`bavapi` is a Python SDK for the WPP BAV API.\n\nIt is published on [PyPI](https://pypi.org/project/wpp-bavapi/) as `wpp-bavapi`.\n\nWith `bavapi` you can access the full BAV data catalog, the largest and most comprehensive database of brand data in the world.\n\nQueries are validated automatically thanks to `pydantic` and retrieved asynchronously via the `httpx` package.\n\nFor more information about the API, go to the [WPPBAV Developer Hub](https://developer.wppbav.com).\n\n## Prerequisites\n\n`bavapi` requires Python 3.8 or higher to run.\n\nIf you don't have Python installed, you can find it from the [official](https://www.python.org/downloads/) website or via [Anaconda](https://www.anaconda.com/).\n\nYou will also need a BAV API token. For more information, go to the [Authentication](https://developer.wppbav.com/docs/2.x/authentication) section of the API documentation.\n\n### Dependencies\n\n- `httpx >= 0.20`\n- `nest-asyncio >= 1.5`\n- `pandas >= 1.0`\n- `pydantic >= 2.0`\n- `tqdm >= 4.62`\n- `typing-extensions >= 4.6` for Python < 3.12\n\n## Installation\n\n`bavapi` can be installed using `pip`:\n\n```prompt\npip install wpp-bavapi\n```\n\n### Installing from source\n\nTo install from source, clone the GitHub repository into your local machine:\n\n```prompt\ngit clone https://github.com/wppbav/bavapi-sdk-python.git\n```\n\nGo into the cloned directory and install `bavapi`:\n\n```prompt\ncd bavapi-sdk-python\npip install .\n```\n\n## Usage\n\nOnce you have acquired a token, you can start using this library directly in python or in a Jupyter Notebook:\n\n```py\n>>> import bavapi\n>>> result = bavapi.brands(\"TOKEN\", name=\"Swatch\") # Replace `\"TOKEN\"` with your BAV API token\n>>> result\n```\n\n| | sector_id | sector_name | id | name | ... |\n| --: | :-------- | :-------------------- | :--- | :----- | :-- |\n| 0 | 233 | Apparel & Accessories | 8635 | Swatch | ... |\n| ... | ... | ... | ... | ... | ... |\n\n## Features\n\n- Support for all endpoints in the WPPBAV Fount API.\n - Extended support for the following endpoints:\n - `audiences`\n - `audience-groups`\n - `brand-metrics`\n - `brand-metric-groups`\n - `brands`\n - `brandscape-data`\n - `categories`\n - `cities`\n - `collections`\n - `companies`\n - `countries`\n - `sectors`\n - `studies`\n - `years`\n - Other endpoints are available via the `raw_query` functions and methods.\n - Extended support for Fount API Tools/TurboPitch endpoints.\n- Validates query parameters are of the correct types and provides type hints for better IDE support.\n- Retrieve multiple pages of data simultaneously, monitoring and preventing exceeding API rate limit.\n- Both synchronous and asynchronous APIs for accessing BAV data.\n\n## Documentation\n\nRead more about `bavapi` in the [documentation](https://wppbav.github.io/bavapi-sdk-python/).\n\n## Issues\n\nPlease file an issue on GitHub [here](https://github.com/wppbav/bavapi-sdk-python/issues).\n\n## Contributing\n\nPlease see the [Contributing](https://wppbav.github.io/bavapi-sdk-python/contributing/) section of the documentation for more information.\n",
"bugtrack_url": null,
"license": "Apache 2.0",
"summary": "Python consumer for the WPPBAV Fount API.",
"version": "1.1.0",
"project_urls": {
"api_reference": "https://developer.wppbav.com/docs/2.x/intro",
"homepage": "https://wppbav.github.io/bavapi-sdk-python/",
"repository": "https://github.com/wppbav/wpp-bavapi/"
},
"split_keywords": [
"wpp-bavapi",
" bavapi",
" bavgroup",
" bav",
" brandasset",
" brandassetvaluator",
" wppbav",
" wpp",
" fount"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d51515199472254e783707dcd0be2225c4e63b19d7f813fb2f9fad3120466986",
"md5": "547e057bce6bc697f4d510156b237528",
"sha256": "f489f4f60b859bda31383ca90fe518ffb752c7874a7299e70dca2902c6af6fd0"
},
"downloads": -1,
"filename": "wpp_bavapi-1.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "547e057bce6bc697f4d510156b237528",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 49333,
"upload_time": "2024-05-20T14:36:30",
"upload_time_iso_8601": "2024-05-20T14:36:30.830931Z",
"url": "https://files.pythonhosted.org/packages/d5/15/15199472254e783707dcd0be2225c4e63b19d7f813fb2f9fad3120466986/wpp_bavapi-1.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1def0ecc31672deba5d8f2f6664ca006de69d6cdfdc2abdd6197d17824e3e9eb",
"md5": "7f38a176085bb589599e4cc6a2f32da7",
"sha256": "a6a04397cb3a76911d961ceb1027d7b3d59fd367b1a9119498dfed51fd149899"
},
"downloads": -1,
"filename": "wpp_bavapi-1.1.0.tar.gz",
"has_sig": false,
"md5_digest": "7f38a176085bb589599e4cc6a2f32da7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 54326,
"upload_time": "2024-05-20T14:36:32",
"upload_time_iso_8601": "2024-05-20T14:36:32.761387Z",
"url": "https://files.pythonhosted.org/packages/1d/ef/0ecc31672deba5d8f2f6664ca006de69d6cdfdc2abdd6197d17824e3e9eb/wpp_bavapi-1.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-20 14:36:32",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "wppbav",
"github_project": "wpp-bavapi",
"github_not_found": true,
"lcname": "wpp-bavapi"
}
JSON
