POC - External packages as component libraries

[timsavage]

Description:

This pull request implements support for multiple component libraries and loading additional packages via entry points (more details in the feature request linked below).

The existing component locations are given priority (in the existing order).

A sample component library package:
https://github.com/timsavage/esphome-poc-component-lib

Related issue (if applicable): implementation of esphome/feature-requests#542

Pull request in esphome-docs with documentation (if applicable): Docs will be written to go with this.

Checklist:

• The code change is tested and works locally.
• Tests have been added to verify that the new code works (under tests/ folder).

If user exposed functionality or configuration variables are added/changed:

• Documentation added/updated in esphome-docs.

[stale]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

[glmnet]

Hey there, just looking at this... is there any other way to get the extra component besides cloning the repo and doing the python setup.py develop magic?

Reason I ask is because most people uses ESPHome with dashboard inside Hass "supervisor"

May be, the dashboard could install more "stuff"? like a new option in the dashboard where you give it the git repos url and it will take care of installing the thing, i.e. cloning and running the setup.py

Then you could see on the dashboard which "extras" you had installed, maybe some other thing needs to be done there? like requiring some metadata on the setup.py?

I really don't know much of setup.py stuff this is all magic for me.

Another option I'd like maybe more will be adding the git urls inside the yaml itself, much more like you tell esphome additional libraries or files to include, etc.

[timsavage]

If the package is published, you can just pip install them. Either from PyPI or directly to a git repo.

Behind the scenes, most of the work is handled by the pkg_resources package and looking for the specific entry point defined in your setup.py (or setup.cfg), the same trick can be used to read in other package metadata which would allow for the list of extras to be displayed on the dashboard.

The main advantages I can see is this would allow for components to be decoupled from the core application, letting components get released more often.

As to being inside the Hass supervisor, that is fine, I would assume that esphome is installed via pip, the install would the change to pip install -U esphome esphome-components with any others the user wanted appended or of course esphome-components would be marked as a dependency of esphome in which case it would get installed at the same time.

[oxan]

Is this still relevant with the introduction of external components? They both seem to provide the same functionality, albeit in a different way.

[OttoWinter]

Agree @oxan , we can close this.