Craftoncu / hacs-vikunja-integration

Embed your Vikunja Tasks into HomeAssistant
MIT License
32 stars 8 forks source link

add some documentation [WIP] #29

Open lordfiSh opened 3 months ago

lordfiSh commented 3 months ago

Hi, first thanks for creating this Addon, but this Addon needs some Documentation. I will list them here and may create a PR for the Readme later

What API Permission are needed? If I just tick every Box in Tasks, that seems to be not enough

Something really wrong happened!
Traceback (most recent call last):
  File "/config/custom_components/hacs_vikunja_integration/api.py", line 95, in _api_wrapper
    raise HacsVikunjaIntegrationApiClientAuthenticationError(
custom_components.hacs_vikunja_integration.api.HacsVikunjaIntegrationApiClientAuthenticationError: Invalid credentials

The above exception was the direct cause of the following exception:

Traceback (most recent call last):
  File "/config/custom_components/hacs_vikunja_integration/config_flow.py", line 31, in async_step_user
    await self._test_credentials(
  File "/config/custom_components/hacs_vikunja_integration/config_flow.py", line 79, in _test_credentials
    await client.list_projects()
  File "/config/custom_components/hacs_vikunja_integration/api.py", line 48, in list_projects
    return await self._api_wrapper(method="get", url=url, headers=headers)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/config/custom_components/hacs_vikunja_integration/api.py", line 110, in _api_wrapper
    raise HacsVikunjaIntegrationApiClientError(
custom_components.hacs_vikunja_integration.api.HacsVikunjaIntegrationApiClientError: Something really wrong happened!

What Version is needed? I had some old Version running, you need need at least Version 0.23.0, with the new API System

Where to find the To-do lists Only found the new Todo Entities , but not the Tasks itself. Took a bit to find the new Item in the Navbar image

and its using the new Home Assistant ToDo List Function, added in 2023.11.

image

Can you use Automations? ?

Can you filter the Todo lists (closed, overdue...) ?

Craftoncu commented 1 week ago

Hey, sorry. Ive seen this issue right now. My permissions on the vikuna side are like this: image

I stopped using vikunja, because we migrated to YouTrack. But im still open to help. Automations are not available except the ones which u can use for home assistant's todo lists.

There is no filter available. It should only list undone tasks