Unofficial package to access Bring! shopping lists API.
Project description
Bring! Shopping Lists API
An unofficial python package to access the Bring! shopping lists API.
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
pip install bring-api
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.bring 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())
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: <function _ProactorBasePipeTransport.__del__ at 0x00000000>
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
# Run tests locally (using a .env file is supported and recommended)
export EMAIL=...
export PASSWORD=...
export LIST=...
python test.py
Following VSCode integrations may be helpful:
CHANGELOG
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_caeuser_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.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for bring_api-0.4.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2d5a397e35e93e8a457591f033b2bd3adcb063d721f0176de1f486ae3f4410e9 |
|
MD5 | dee136bb8bfc5a63e7c81519e5e4ae1d |
|
BLAKE2b-256 | 6463825e540827bf397fd307a89f758b3e47161a0de54d545b0e1080be2f6b28 |