cookidoo-api 0.3.0

Unofficial package to access Cookidoo.

Cookidoo API

An unofficial python package to access Cookidoo.

Disclaimer

The developers of this module are in no way endorsed by or affiliated with Cookidoo or Vorwerk, or any associated subsidiaries, logos or trademarks.

Installation

Disclaimer: This library needs a runner (browser) to execute the calls through web automation. Make sure to have it correctly set up using one of the following options before proceeding.

Setup runner

Once you have tested your runner, install the cookidoo library and use it with your preferred browser.

pip install cookidoo-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 implementation of the library playwright in collaboration with a runner for browser emulation.

Make sure to have stored your credentials in the top-level file .env as such, to loaded by dotenv. Alternatively, provide the environment variables by any other dotenv compatible means.

EMAIL=[e-mail]
PASSWORD=password

Run the example script and have a look at the inline comments for more explanation.

Exceptions

In case something goes wrong during a request, several exceptions can be thrown. They will either be

• CookidooActionException
• CookidooAuthBotDetectionException
• CookidooAuthException
• CookidooConfigException
• CookidooNavigationException
• CookidooSelectorException
• CookidooUnavailableException
• CookidooUnexpectedStateException

depending on the context. All inherit from CookidooException.

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())

Bot detection and captcha problems

There is an inbuilt bot detection on cookidoo which can block the login process. There is a clear error message, when that happens. The tokens are valid for a fixed duration and therefore the library tries to minimize the amount of logins required to avoid the captcha process. Unfortunately, this is not always possible when developing or debugging a setup, and you might run into it. To continue, either wait a day or switch to a runner with a gui and enable captcha mode to manually solve the captcha during the login or a service such as capsolver.

It is generally advised, to first try the login in fail mode and only activate a recovery mode on a CookidooAuthBotDetectionException raised.

Captcha recovery mode user_input

cookidoo = Cookidoo(<your headful browser setup>)
await cookidoo.login(captcha_recovery_mode="user_input")

Be aware, using this option with a headless browser will indefinitely block the process in login, as it is waiting for user action.

Captcha recovery mode capsolver

This requires the capsolver to be installed.

pip install capsolver

cookidoo = Cookidoo(<your browser setup>)
await cookidoo.login(captcha_recovery_mode="capsolver")

This is not yet implemented.

Alternatively, they also provide a browser extension, which might be a cleaner way.

Dev

Setup the dev environment using VSCode, it 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 master branch. For it to pass the gates of the publish workflow, it must have the same version in the tag, the cookidoo_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 master branch). Also, prerelease versions are marked as such in the github release page.

CHANGELOG

0.3.0

• add check method to quickly verify browser functionality

0.2.0

• add method to add items when in free account
• auto-close feedback modal when in free account

0.1.1

• fix build

0.1.0

Initial commit.