Bring! Shopping Lists API

An unofficial python package to access the Bring! shopping lists API.

@miaucl

@tr4nt0r

Credits

> This implementation of the api is derived from the generic python implementation by eliasball, which uses the legacy version of the api. This fork has been synced last time on 2024-02-11 and diverges from that point on using the non-legacy version. The implementation of eliasball is a minimal python port of the node-bring-api by foxriver76. All credit goes to him for making this awesome API possible!

Disclaimer

The developers of this module are in no way endorsed by or affiliated with Bring! Labs AG, or any associated subsidiaries, logos or trademarks.

Installation

As python package from PyPI

pip install bring-api

Available as integration in Home Assistant

Documentation

See below for usage examples. See Exceptions for API-specific exceptions and mitigation strategies for common exceptions.

Usage Example

The API is based on the async HTTP library aiohttp.

import aiohttp
import asyncio
import logging
import sys

from bring_api import Bring

logging.basicConfig(stream=sys.stdout, level=logging.DEBUG)

async def main():
  async with aiohttp.ClientSession() as session:
    # Create Bring instance with email and password
    bring = Bring(session, "MAIL", "PASSWORD")
    # Login
    await bring.login()

    # Get information about all available shopping lists
    lists = (await bring.load_lists())["lists"]

    # Save an item with specifications to a certain shopping list
    await bring.save_item(lists[0]['listUuid'], 'Milk', 'low fat')

    # Save another item
    await bring.save_item(lists[0]['listUuid'], 'Carrots')

    # Get all the items of a list
    items = await bring.get_list(lists[0]['listUuid'])
    print(items)

    # Check off an item
    await bring.complete_item(lists[0]['listUuid'], 'Carrots')

    # Remove an item from a list
    await bring.remove_item(lists[0]['listUuid'], 'Milk')

asyncio.run(main())

Manipulating lists with batch_update_list

This method uses the newer API endpoint for adding, completing and removing items from a list, which is also used in the Bring App. The items can be identified by their uuid and therefore some things are possible that are not possible with the legacy endpoints like:

• Add/complete/remove multiple items at once
• Adding multiple items with the same Name but different specifications
• You can work with a unique identifier for an item even before adding it to a list, just use uuid4 to generate a random uuid!

Usage examples:

Add an item

When adding an item, the itemId is required, spec and uuid are optional. If you need a unique identifier before adding an item, you can just generate a uuid4.

item = {
  "itemId": "Cilantro",
  "spec": "fresh",
  "uuid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx"
}
await bring.batch_update_list(
  lists[0]['listUuid'],
  item,
  BringItemOperation.ADD)

Updating an items specification

When updating an item, use ADD operation again. The itemId is required and the item spec will be added/updated on the existing item on the list. For better matching an existing item (if there is more than one item with the same itemId), you can use it's unique identifier uuid.

item = {
  "itemId": "Cilantro",
  "spec": "dried",
  "uuid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx"
}
await bring.batch_update_list(
  lists[0]['listUuid'],
  item,
  BringItemOperation.ADD)

Multiple items

# multiple items can be passed as list of items
items = [{
  "itemId": "Cilantro",
  "spec": "fresh",
  "uuid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx"
},
{
  "itemId": "Parsley",
  "spec": "dried",
  "uuid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx"
}]
await bring.batch_update_list(
  lists[0]['listUuid'],
  items,
  BringItemOperation.ADD)

Add multiple items with the same name but different specifications

When adding items with the same name the parameter uuid is required, otherwise the previous item will be matched by itemId and it's specification will be overwritten

items = [
  {
    "itemId": "Cilantro",
    "spec": "100g, dried",
    "uuid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx"
  },
    {
    "itemId": "Cilantro",
    "spec": "fresh",
    "uuid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx"
  }
]
await bring.batch_update_list(
  lists[0]['listUuid'],
  items,
  BringItemOperation.ADD)

Removing or completing an item

When removing or completing an item you must submit itemId and uuid, spec is optional. Only the uuid will not work. Leaving out the uuid and submitting itemId and spec will also work. When submitting only itemId the Bring API will match the oldest item.

await bring.batch_update_list(
  lists[0]['listUuid'],
  {"itemId": "Cilantro", "uuid" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx"},
  BringItemOperation.REMOVE)

await bring.batch_update_list(
  lists[0]['listUuid'],
  {"itemId": "Cilantro", "uuid" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx"},
  BringItemOperation.COMPLETE)  

Renaming an item (not recommended)

An item that is already on the list can be renamed by sending it's uuid with a changed itemId. But it is highly advised against it because the Bring App will behave weirdly as it does not refresh an items name, not even when force reloading (going to the top of the list and pulling down). Users have to close the list by going to the overview or closing the app and only then when the list is completely refreshed the change of the name will show up.

# Add an item
item = {
  "itemId": "Cilantro",
  "uuid" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx"
}
await bring.batch_update_list(
  lists[0]['listUuid'],
  item,
  BringItemOperation.ADD)

# Rename the item, and submit it again with the same uuid
item["itemId"] = "Coriander"
await bring.batch_update_list(
  lists[0]['listUuid'],
  item,
  BringItemOperation.ADD)  

Exceptions

In case something goes wrong during a request, several exceptions can be thrown. They will either be BringRequestException, BringParseException, or BringAuthException, depending on the context. All inherit from BringException.

Another asyncio event loop is

With the async calls, you might encounter an error that another asyncio event loop is already running on the same thread. This is expected behavior according to the asyncio.run() documentation. You cannot use more than one aiohttp session per thread, reuse the existing one!

Exception ignored: RuntimeError: Event loop is closed

Due to a known issue in some versions of aiohttp when using Windows, you might encounter a similar error to this:

Exception ignored in: 
Traceback (most recent call last):
  File "C:\...\py38\lib\asyncio\proactor_events.py", line 116, in __del__
    self.close()
  File "C:\...\py38\lib\asyncio\proactor_events.py", line 108, in close
    self._loop.call_soon(self._call_connection_lost, None)
  File "C:\...\py38\lib\asyncio\base_events.py", line 719, in call_soon
    self._check_closed()
  File "C:\...\py38\lib\asyncio\base_events.py", line 508, in _check_closed
    raise RuntimeError('Event loop is closed')
RuntimeError: Event loop is closed

You can fix this according to this stackoverflow answer by adding the following line of code before executing the library:

asyncio.set_event_loop_policy(asyncio.WindowsSelectorEventLoopPolicy())

Dev

Setup the dev environment using VSCode, is is highly recommended.

python -m venv .venv
source .venv/bin/activate
pip install -r requirements_dev.txt

Install pre-commit

pre-commit install

# Run the commit hooks manually
pre-commit run --all-files

Following VSCode integrations may be helpful:

• ruff
• mypy
• markdownlint

Releasing

It is only possible to release a final version on the main branch. For it to pass the gates of the publish workflow, it must have the same version in the tag, the bring_api/__init__.py and an entry in the CHANGELOG.md file.

To release a prerelease version, no changelog entry is required, but it can only happen on a feature branch (not main branch). Also, prerelease versions are marked as such in the github release page.

CHANGELOG

0.9.1

• Don't raise BringParseException on parsing errors for unauthorized request responses

0.9.0

• Add type hints for item attributes (purchase conditions)
• Minor code quality improvements, fix typos and upgrade type annotations

0.8.1

• Reload locales after setting list language to ensure all required article translations are available

0.8.0

• New API method: set_list_article_language sets the article language for a specified shopping list.

0.7.3

• Change name and photoPath in type definitions for BringSyncCurrentUserResponse and BringAuthResponse to optional parameters
• Add py.typed file so that type checkers can use type annotations

0.7.2

• fix bug in debug log message.

0.7.1

• Fix get_list method not returning uuid and status from JSON response
• Log to debug instead of error where exceptions are already raised.
• Add raw server response to debug log messages.
• Update docstrings

0.7.0

• New API method: retrieve_new_access_token retrieves a new access token and updates authorization headers. Time till expiration of the access token is stored in the property expires_in . (tr4nt0r)
• All API methods that require authentication now raise BringAuthException for 401 Unauthorized status (tr4nt0r)

0.6.0

• Pytest unit testing: added pytest with full code coverage (tr4nt0r)
• Github workflow for pytest: added workflow for running pytests with Python 3.11 & 3.12 on Ubuntu, Windows and macOS (tr4nt0r)
• Update Python requirement to >=3.11
• Change from implicit to explicit string conversion of BringItemOperation in JSON request payload (tr4nt0r)
• Change Type of BringItemOperation to StrEnum (tr4nt0r)
• BringItem::operation now also accepts string literals TO_PURCHASE, TO_RECENTLY & REMOVE (tr4nt0r)
• fix wrong variable name in BringSyncCurrentUserResponse class and add additional variables from JSON response (tr4nt0r)
• Improve exceptions for save/update/remove/complete_item and batch_update_list methods (tr4nt0r)
• Fix bug in get_all_item_details method (tr4nt0r)
• Parsing error when parsing unauthorized response now raises BringParseException (tr4nt0r)
• Cleanup legacy code (tr4nt0r)

0.5.7

• map user language to locales: Bring sometimes stores non-standard locales in the user settings. In case the Bring API returns an invalid/unsupported locale, the user language is now mapped to a supported locale.

0.5.6

• fix incorrect filtering of locales against supported locales list

0.5.5

• Fix KeyError when listArticleLanguage is not set.

0.5.4

• Load article translations from file in executor instead of event loop.

0.5.3

• Improve mypy type checking.

0.5.2

• Fixed build script to add locales explicitly.

0.5.1

• Add article translation tables to package. Translation tables are now loaded from file as data from web app is outdated.

0.5.0

• New API method: batch_update_list. Uses the same API endpoint as the mobile app to add, complete and remove items from shopping lists and has support for uuid as unique identifier for list items.
• save_item, update_item, complete_item and remove_item are now wrapper methods for batch_update_list and have the additional parameter item_uuid.

0.4.1

• instead of downloading all translation tables, required locales are determined from the user list settings and the user locale. (tr4nt0r)
• variable userlistsettings renamed to snake_cae user_list_settings. (tr4nt0r)

0.4.0

• Localization support: catalog items are now automatically translated based on the shopping lists language if configured, otherwise the users default language is used (tr4nt0r)
• New API method: get_user_account. Retrieves information about the current user like email, name and language (tr4nt0r)
• New API method: get_all_user_settings. Retrieves user settings like default list and individual list settings for section order and language (tr4nt0r)

0.3.1

• Unpin requirements and remove subdependencies (tr4nt0r)

0.3.0

• Refactor for PEP8 compliance and code clean-up (breaking change) (tr4nt0r)

0.2.0

• Add new method does_user_exist (tr4nt0r)
• Fixes for test workflow

0.1.4

Add test workflow.

0.1.3

Add mypy for type-checking.

0.1.2

Add ruff as formatter and linter.

0.1.1

Change name of package to bring-api.

0.1.0

Test publish workflow for pypi, no code related changes.

0.0.1

Initial commit based on 3.0.0 from eliasball.