Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[FEATURE] Add plugin manager to tiflash #85

Open
webbcam opened this issue Aug 22, 2019 · 0 comments
Open

[FEATURE] Add plugin manager to tiflash #85

webbcam opened this issue Aug 22, 2019 · 0 comments
Labels
feature New feature or request

Comments

@webbcam
Copy link
Owner

webbcam commented Aug 22, 2019

Feature Description
Add a plugin manager/framework to allow developers to create plugins for tiflash. Plugins would be created as separate pip installable python packages. Users could then install whichever plugins they want and tiflash would automatically pick up the installed plugins and provide access to their functionality.

Example: a BLE device plugin (tiflash-ble) that adds BLE specific functions such as:

  • read_primary_ble_addr()
  • read_secondary_ble_addr()
  • write_secondary_ble_addr()

After installing the plugin (pip install tiflash-ble) the user would have access to those functions with their tiflash installation.
tiflash.read_primary_ble_addr(serno="L11000CE")

Why feature is requested
Having a plugin framework would allow users to extend tiflash to meet their specific needs without adding device specific code into tiflash.

Describe the solution you'd like
I think using pluggy would be best. Pluggy is used by many popular open source tools such as: pytest and tox

Each plugin would be named with the format "tiflash-<plugin name>". This would allow tiflash to pick up any plugin that was installed via pip automatically.

@webbcam webbcam added the feature New feature or request label Aug 22, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant