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

Verification Request: homebridge-kasa-python #746

Closed
ZeliardM opened this issue Aug 10, 2024 · 12 comments
Closed

Verification Request: homebridge-kasa-python #746

ZeliardM opened this issue Aug 10, 2024 · 12 comments
Labels
verified use when a plugin meets the criteria - adds the verified badge text

Comments

@ZeliardM
Copy link

Plugin Name

homebridge-kasa-python

Link To GitHub Repo

https://github.com/ZeliardM/homebridge-kasa-python

Plugin Icon (Optional)

icon

The plugin does not offer the same nor less functionality than that of any existing verified plugin.

🟠 No (please explain in the more information box at the end)

The plugin successfully installs and does not start unless it is configured.

🟢 Yes

The plugin does not require the user to run Homebridge in a TTY or with non-standard startup parameters, even for initial configuration.

🟢 Yes

The plugin does not contain any analytics or calls that enable you to track the user.

🟢 Yes

If the plugin needs to write files to disk (cache, keys, etc.), it stores them inside the Homebridge storage directory.

🟢 Yes

The plugin does not throw unhandled exceptions, the plugin must catch and log its own errors.

🟢 Yes

More Information

There is an existing verified plug-in:
https://github.com/plasticrake/homebridge-tplink-smarthome
This plug-in has not been updated in 6 months and api have not been updated in 9 months. Several outstanding issues and user reported errors without fixes.
My plug-in uses a new python api that Home Assistant has just moved to for use and while I do not have the functionality of the api integrated yet, I am working on it.
I would also like to have a channel created on the discord server for user discussion if needed, I'm on discord a lot.

@ZeliardM ZeliardM added the pending the label given to a new verification/icon request label Aug 10, 2024
Copy link

🔴 The following pre-checks failed:

  • Package JSON: engines.node property is not compatible with Node 18
  • Package JSON: engines.node property is not compatible with Node 20
  • Package JSON: engines.homebridge property is not compatible with Homebridge 1.7.0

🟢 The following pre-checks passed:

  • Installation: successfully installed
  • Package JSON: homepage exists
  • Package JSON: bugs.url exists and seems a valid URL
  • Package JSON: keywords exist and contain 'homebridge-plugin'
  • Package JSON: 'preinstall' in scripts is not present
  • Package JSON: 'install' in scripts is not present
  • Package JSON: 'postinstall' in scripts is not present
  • Package JSON: initializer function found
  • GitHub Repo: repository is public
  • GitHub Repo: repository is not archived
  • GitHub Repo: issues are enabled
  • GitHub Repo: contains releases
  • NPM Package: has not been deprecated
  • Config Schema JSON: exists and is valid JSON
  • Config Schema JSON: contains a valid pluginAlias
  • Config Schema JSON: the pluginType is set to 'platform'
  • Config Schema JSON: contains a name schema property
  • Dependencies: homebridge was not installed as a dependency
  • Dependencies: hap-nodejs was not installed as a dependency

⚠️ Please action these failures and then comment /check to run the checks again. Let us know if you need any help.

If updating your package.json and config.schema.json files, don't forget to publish a new version to NPM.

@github-actions github-actions bot added awaiting-changes use after review has started - awaiting user to make changes to plugin and removed pending the label given to a new verification/icon request labels Aug 10, 2024
@ZeliardM
Copy link
Author

I think your checks for verification need to be updated.

I am using the latest template with engines defined as:
"engines": {
"node": "^18.20.4 || ^20.16.0 || ^22.6.0",
"homebridge": "^1.8.0 || ^2.0.0-beta.0",
"python": "^3.9.0"
},
The pre-check says it fails because of node 18 and 20, which it does support, and homebridge 1.7.0 which is not listed in the latest plug-in template.

Please advise.

@mkz212
Copy link

mkz212 commented Aug 10, 2024

https://github.com/homebridge/verified/blob/latest/precheck/workspace/index.ts

From line 163. I think it's like you say. Now it is that it must be compatible with homebridge 1.7.0 but it should be 1.8.0. Also node should be changed from 18.20.1 to 18.20.4 and from 20.12.0 to 20.16.0 .

@ZeliardM
Copy link
Author

I think that it should also be updated to include node 22 and Homebridge 2.0 as well since those are now in the templates as well.

@mkz212
Copy link

mkz212 commented Aug 10, 2024

@ZeliardM

This script checks whether your plugin supports the required versions. Node 22 is not required because the official version is from October 2024.

I did PR with fixes for this.

@ZeliardM
Copy link
Author

@mkz212 gotcha, thanks!

@bwp91
Copy link
Contributor

bwp91 commented Aug 10, 2024

/check

@github-actions github-actions bot added pending the label given to a new verification/icon request and removed awaiting-changes use after review has started - awaiting user to make changes to plugin labels Aug 10, 2024
Copy link

🟢 The following checks passed:

  • Installation: successfully installed
  • Package JSON: homepage exists
  • Package JSON: bugs.url exists and seems a valid URL
  • Package JSON: keywords exist and contain 'homebridge-plugin'
  • Package JSON: 'preinstall' in scripts is not present
  • Package JSON: 'install' in scripts is not present
  • Package JSON: 'postinstall' in scripts is not present
  • Package JSON: engines.node property is compatible with Node 18
  • Package JSON: engines.node property is compatible with Node 20
  • Package JSON: engines.homebridge property is compatible with Homebridge 1.8.4
  • Package JSON: initializer function found
  • GitHub Repo: repository is public
  • GitHub Repo: repository is not archived
  • GitHub Repo: issues are enabled
  • GitHub Repo: contains releases
  • NPM Package: has not been deprecated
  • Config Schema JSON: exists and is valid JSON
  • Config Schema JSON: contains a valid pluginAlias
  • Config Schema JSON: the pluginType is set to 'platform'
  • Config Schema JSON: contains a name schema property
  • Dependencies: homebridge was not installed as a dependency
  • Dependencies: hap-nodejs was not installed as a dependency

🎉 All checks passed successfully, nice work! Your plugin and/or icon will now be manually reviewed by the Homebridge team.

@mkz212
Copy link

mkz212 commented Aug 10, 2024

@ZeliardM Congratulations on passing the exam 😀🎉

@ZeliardM
Copy link
Author

@mkz212 @bwp91 thank you both! I appreciate it and really enjoy this community!

@bwp91 bwp91 added currently-reviewing use for starting a review - adds a comment with the verification list with empty checkboxes and removed pending the label given to a new verification/icon request labels Sep 22, 2024
Copy link

github-actions bot commented Sep 22, 2024

  • General
    • The plugin must be of type dynamic platform.
    • The plugin must not offer the same nor less functionality than that of any existing verified plugin.
  • Repo
    • The plugin must be published to NPM and the source code available on a GitHub repository, with issues enabled.
    • A GitHub release should be created for every new version of your plugin, with release notes.
  • Environment
    • The plugin must run on all supported LTS versions of Node.js, at the time of writing this is Node v18 and v20.
    • The plugin must successfully install and not start unless it is configured.
    • The plugin must not execute post-install scripts that modify the users' system in any way.
    • The plugin must not require the user to run Homebridge in a TTY or with non-standard startup parameters, even for initial configuration.
  • Codebase
    • The plugin must implement the Homebridge Plugin Settings GUI.
    • The plugin must not contain any analytics or calls that enable you to track the user.
    • If the plugin needs to write files to disk (cache, keys, etc.), it must store them inside the Homebridge storage directory.
    • The plugin must not throw unhandled exceptions, the plugin must catch and log its own errors.

@bwp91 bwp91 added verified use when a plugin meets the criteria - adds the verified badge text and removed currently-reviewing use for starting a review - adds a comment with the verification list with empty checkboxes labels Sep 22, 2024
Copy link

Congratulations! Your plugin has been verified!

You can now add one of the Verified by Homebridge badges to your plugin's README:

verified-by-homebridge

[![verified-by-homebridge](https://badgen.net/badge/homebridge/verified/purple)](https://github.com/homebridge/homebridge/wiki/Verified-Plugins)

verified-by-homebridge

[![verified-by-homebridge](https://img.shields.io/badge/homebridge-verified-blueviolet?color=%23491F59&style=for-the-badge&logoColor=%23FFFFFF&logo=homebridge)](https://github.com/homebridge/homebridge/wiki/Verified-Plugins)

Your plugin is now also eligible to display a ❤️ Donate button on its tile in the Homebridge UI. See https://github.com/homebridge/homebridge/wiki/Donation-Links for instructions.

If for any reason in the future you can no longer maintain your plugin, please consider transferring it to our unmaintained plugins repo. We can take ownership until another willing developer comes along.

Don't forget to join the official Homebridge Discord server, where plugin developers can get tips and advice from other developers and the Homebridge project team in the #plugin-development channel!

As a verified plugin, you can request a channel in the Discord server to discuss your plugin with users and other developers. Just ask in the #plugin-development channel.

Thank you for your contribution to the Homebridge community.

  • The Homebridge Team

bwp91 added a commit that referenced this issue Sep 22, 2024
@bwp91 bwp91 closed this as completed Sep 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
verified use when a plugin meets the criteria - adds the verified badge text
Projects
None yet
Development

No branches or pull requests

3 participants