diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index b4ff77d..0edb202 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -19,7 +19,7 @@ repos: stages: [manual] - id: check-json - id: trailing-whitespace - files: ^((xknx-custom-panel)/.+)?[^/]+\.py$ + files: ^((xknx_custom_panel)/.+)?[^/]+\.py$ - repo: https://github.com/cdce8p/python-typing-update rev: v0.3.5 hooks: @@ -32,7 +32,7 @@ repos: - --py39-plus - --force - --keep-updates - files: ^(xknx-custom-panel)/.+\.py$ + files: ^(xknx_custom_panel)/.+\.py$ # Frontend - repo: https://github.com/pre-commit/mirrors-prettier rev: v2.6.2 diff --git a/README.md b/README.md index a53c832..425e26c 100644 --- a/README.md +++ b/README.md @@ -19,32 +19,6 @@ knx_panel: ![Bus Monitor](./screenshots/bus_monitor.png?raw=true) -## Installation - -### Manual - -- Place the custom_components folder in your configuration directory (or add its contents to an existing custom_components folder). It should look similar to this: - -``` -/ -|-- custom_components/ -| |-- knx_panel/ -| |-- __init__.py -| |-- knx_ui.js -| |-- ... -``` - -- Edit your configuration.yaml file according to the example above - - -### HACS (Not yet supported!) - -If you want HACS to handle installation and updates, add _KNX Panel_ as a custom repository. - -NOTE: This is currently not yet supported! - - - ## Development Please install the pre-commit hook by using: diff --git a/setup.py b/setup.py index fbab3e9..be10e0f 100644 --- a/setup.py +++ b/setup.py @@ -28,8 +28,8 @@ "Programming Language :: Python :: 3.9", "Programming Language :: Python :: 3.10", ], - packages=find_packages(include=["xknx-custom-panel", "xknx-custom-panel.*"]), - package_data={"xknx-custom-panel": ["knx-ui.js"]}, + packages=find_packages(include=["xknx_custom_panel", "xknx_custom_panel.*"]), + package_data={"xknx_custom_panel": ["knx-ui.js"]}, include_package_data=True, keywords="knx panel xknx custom-panel home-assistant", zip_safe=False, diff --git a/xknx-custom-panel/__init__.py b/xknx_custom_panel/__init__.py similarity index 100% rename from xknx-custom-panel/__init__.py rename to xknx_custom_panel/__init__.py diff --git a/xknx-custom-panel/knx_ui.js b/xknx_custom_panel/knx_ui.js similarity index 100% rename from xknx-custom-panel/knx_ui.js rename to xknx_custom_panel/knx_ui.js