diff --git a/.gitattributes b/.gitattributes index 94f480d..6313b56 100644 --- a/.gitattributes +++ b/.gitattributes @@ -1 +1 @@ -* text=auto eol=lf \ No newline at end of file +* text=auto eol=lf diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml index effbd36..5936c7b 100644 --- a/.github/ISSUE_TEMPLATE/bug.yml +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -2,53 +2,53 @@ name: "Bug report" description: "Report a bug with the integration" body: -- type: markdown - attributes: - value: Before you open a new issue, search through the existing issues to see if others have had the same problem. -- type: textarea - attributes: - label: "System Health details" - description: "Paste the data from the System Health card in Home Assistant (https://www.home-assistant.io/more-info/system-health#github-issues)" - validations: - required: true -- type: checkboxes - attributes: - label: Checklist - options: - - label: I have enabled debug logging for my installation. - required: true - - label: I have filled out the issue template to the best of my ability. - required: true - - label: This issue only contains 1 issue (if you have multiple issues, open one issue for each issue). - required: true - - label: This issue is not a duplicate issue of any [previous issues](https://github.com/ludeeus/integration_blueprint/issues?q=is%3Aissue+label%3A%22Bug%22+).. - required: true -- type: textarea - attributes: - label: "Describe the issue" - description: "A clear and concise description of what the issue is." - validations: - required: true -- type: textarea - attributes: - label: Reproduction steps - description: "Without steps to reproduce, it will be hard to fix. It is very important that you fill out this part. Issues without it will be closed." - value: | - 1. - 2. - 3. - ... - validations: - required: true -- type: textarea - attributes: - label: "Debug logs" - description: "To enable debug logs check this https://www.home-assistant.io/integrations/logger/, this **needs** to include _everything_ from startup of Home Assistant to the point where you encounter the issue." - render: text - validations: - required: true + - type: markdown + attributes: + value: Before you open a new issue, search through the existing issues to see if others have had the same problem. + - type: textarea + attributes: + label: "System Health details" + description: "Paste the data from the System Health card in Home Assistant (https://www.home-assistant.io/more-info/system-health#github-issues)" + validations: + required: true + - type: checkboxes + attributes: + label: Checklist + options: + - label: I have enabled debug logging for my installation. + required: true + - label: I have filled out the issue template to the best of my ability. + required: true + - label: This issue only contains 1 issue (if you have multiple issues, open one issue for each issue). + required: true + - label: This issue is not a duplicate issue of any [previous issues](https://github.com/ludeeus/integration_blueprint/issues?q=is%3Aissue+label%3A%22Bug%22+).. + required: true + - type: textarea + attributes: + label: "Describe the issue" + description: "A clear and concise description of what the issue is." + validations: + required: true + - type: textarea + attributes: + label: Reproduction steps + description: "Without steps to reproduce, it will be hard to fix. It is very important that you fill out this part. Issues without it will be closed." + value: | + 1. + 2. + 3. + ... + validations: + required: true + - type: textarea + attributes: + label: "Debug logs" + description: "To enable debug logs check this https://www.home-assistant.io/integrations/logger/, this **needs** to include _everything_ from startup of Home Assistant to the point where you encounter the issue." + render: text + validations: + required: true -- type: textarea - attributes: - label: "Diagnostics dump" - description: "Drag the diagnostics dump file here. (see https://www.home-assistant.io/integrations/diagnostics/ for info)" + - type: textarea + attributes: + label: "Diagnostics dump" + description: "Drag the diagnostics dump file here. (see https://www.home-assistant.io/integrations/diagnostics/ for info)" diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index ec4bb38..3ba13e0 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1 +1 @@ -blank_issues_enabled: false \ No newline at end of file +blank_issues_enabled: false diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml index d424df6..b582ccf 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -2,45 +2,45 @@ name: "Feature request" description: "Suggest an idea for this project" body: -- type: markdown - attributes: - value: Before you open a new feature request, search through the existing feature requests to see if others have had the same idea. -- type: checkboxes - attributes: - label: Checklist - options: - - label: I have filled out the template to the best of my ability. - required: true - - label: This only contains 1 feature request (if you have multiple feature requests, open one feature request for each feature request). - required: true - - label: This issue is not a duplicate feature request of [previous feature requests](https://github.com/ludeeus/integration_blueprint/issues?q=is%3Aissue+label%3A%22Feature+Request%22+). - required: true + - type: markdown + attributes: + value: Before you open a new feature request, search through the existing feature requests to see if others have had the same idea. + - type: checkboxes + attributes: + label: Checklist + options: + - label: I have filled out the template to the best of my ability. + required: true + - label: This only contains 1 feature request (if you have multiple feature requests, open one feature request for each feature request). + required: true + - label: This issue is not a duplicate feature request of [previous feature requests](https://github.com/ludeeus/integration_blueprint/issues?q=is%3Aissue+label%3A%22Feature+Request%22+). + required: true -- type: textarea - attributes: - label: "Is your feature request related to a problem? Please describe." - description: "A clear and concise description of what the problem is." - placeholder: "I'm always frustrated when [...]" - validations: - required: true + - type: textarea + attributes: + label: "Is your feature request related to a problem? Please describe." + description: "A clear and concise description of what the problem is." + placeholder: "I'm always frustrated when [...]" + validations: + required: true -- type: textarea - attributes: - label: "Describe the solution you'd like" - description: "A clear and concise description of what you want to happen." - validations: - required: true + - type: textarea + attributes: + label: "Describe the solution you'd like" + description: "A clear and concise description of what you want to happen." + validations: + required: true -- type: textarea - attributes: - label: "Describe alternatives you've considered" - description: "A clear and concise description of any alternative solutions or features you've considered." - validations: - required: true + - type: textarea + attributes: + label: "Describe alternatives you've considered" + description: "A clear and concise description of any alternative solutions or features you've considered." + validations: + required: true -- type: textarea - attributes: - label: "Additional context" - description: "Add any other context or screenshots about the feature request here." - validations: - required: true + - type: textarea + attributes: + label: "Additional context" + description: "Add any other context or screenshots about the feature request here." + validations: + required: true diff --git a/.github/dependabot.yml b/.github/dependabot.yml index 04f2d40..eee9634 100644 --- a/.github/dependabot.yml +++ b/.github/dependabot.yml @@ -12,4 +12,4 @@ updates: interval: "weekly" ignore: # Dependabot should not update Home Assistant as that should match the homeassistant key in hacs.json - - dependency-name: "homeassistant" \ No newline at end of file + - dependency-name: "homeassistant" diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml index c6fbe05..4e1e370 100644 --- a/.github/workflows/lint.yml +++ b/.github/workflows/lint.yml @@ -13,20 +13,20 @@ jobs: name: "Ruff" runs-on: "ubuntu-latest" steps: - - name: "Checkout the repository" - uses: "actions/checkout@v4.2.2" + - name: "Checkout the repository" + uses: "actions/checkout@v4.2.2" - - name: "Set up Python" - uses: actions/setup-python@v5.3.0 - with: - python-version: "3.12" - cache: "pip" + - name: "Set up Python" + uses: actions/setup-python@v5.3.0 + with: + python-version: "3.12" + cache: "pip" - - name: "Install requirements" - run: python3 -m pip install -r requirements.txt + - name: "Install requirements" + run: python3 -m pip install -r requirements.txt - - name: "Lint" - run: python3 -m ruff check . + - name: "Lint" + run: python3 -m ruff check . - - name: "Format" - run: python3 -m ruff format . --check + - name: "Format" + run: python3 -m ruff format . --check diff --git a/.github/workflows/validate.yml b/.github/workflows/validate.yml index f00e169..37b3800 100644 --- a/.github/workflows/validate.yml +++ b/.github/workflows/validate.yml @@ -3,7 +3,7 @@ name: "Validate" on: workflow_dispatch: schedule: - - cron: "0 0 * * *" + - cron: "0 0 * * *" push: branches: - "main" @@ -16,22 +16,22 @@ jobs: name: "Hassfest Validation" runs-on: "ubuntu-latest" steps: - - name: "Checkout the repository" - uses: "actions/checkout@v4.2.2" + - name: "Checkout the repository" + uses: "actions/checkout@v4.2.2" - - name: "Run hassfest validation" - uses: "home-assistant/actions/hassfest@master" + - name: "Run hassfest validation" + uses: "home-assistant/actions/hassfest@master" hacs: # https://github.com/hacs/action name: "HACS Validation" runs-on: "ubuntu-latest" steps: - - name: "Checkout the repository" - uses: "actions/checkout@v4.2.2" + - name: "Checkout the repository" + uses: "actions/checkout@v4.2.2" - - name: "Run HACS validation" - uses: "hacs/action@main" - with: - category: "integration" - # Remove this 'ignore' key when you have added brand images for your integration to https://github.com/home-assistant/brands - ignore: "brands" + - name: "Run HACS validation" + uses: "hacs/action@main" + with: + category: "integration" + # Remove this 'ignore' key when you have added brand images for your integration to https://github.com/home-assistant/brands + ignore: "brands" diff --git a/.gitignore b/.gitignore index 0a8519a..fb8d21c 100644 --- a/.gitignore +++ b/.gitignore @@ -5,14 +5,12 @@ __pycache__ */build/* */dist/* - # misc .coverage .vscode coverage.xml .ruff_cache - # Home Assistant configuration config/* -!config/configuration.yaml \ No newline at end of file +!config/configuration.yaml diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 88f2fa7..430e6e9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -40,7 +40,7 @@ Report a bug by [opening a new issue](../../issues/new/choose); it's that easy! - What actually happens - Notes (possibly including why you think this might be happening, or stuff you tried that didn't work) -People *love* thorough bug reports. I'm not even kidding. +People _love_ thorough bug reports. I'm not even kidding. ## Use a Consistent Coding Style