basbruss / adaptive-cover

An Adaptive Cover component for HomeAsisstant to control covers based on the sun's position
MIT License
57 stars 7 forks source link

Unclear dependency handling for local development #172

Closed mion00 closed 1 month ago

mion00 commented 1 month ago

Checklist

Is your feature request related to a problem? Please describe.

I would like to debug locally the project and make some contributions, but I am finding difficult understanding how the dependencies are handled: via poetry or manually via requirements.txt?

In requirements.txt there is a version specified: https://github.com/basbruss/adaptive-cover/blob/5b62166aa877370dfe154a201c57d909c2472070/requirements.txt#L3

Whereas poetry has another: https://github.com/basbruss/adaptive-cover/blob/5b62166aa877370dfe154a201c57d909c2472070/pyproject.toml#L23

Describe the solution you'd like

A guide describing the minimal steps required to bootstrap a development environment.

Describe alternatives you've considered

Using either poetry or requirements.txt to streamline the development process, since keeping both risks a conflicting situation as is happening now.

Additional context

Using VSCode on Linux, launching the provided devcontainer.json configuration, install the requirements from requirements.txt, but in the main folder the poetry.lock suggests that poetry is used.

mion00 commented 1 month ago

So from the merged PR I assume that your preferred way to handle dependencies going forward is using dependencies.txt + pip? If this is the case the poetry files could be safely removed I assume, to avoid confusion.