Add pre-commit setup, SVG icon, HACS configuration

.github/workflows/pre-commit.yml

@@ -0,0 +1,52 @@
+---
+name: pre-commit
+on:
+  pull_request:
+  push:
+jobs:
+  pre-commit:
+    runs-on: ubuntu-latest
+    env:
+      LOG_TO_CS: .github/logToCs.py
+      RAW_LOG: pre-commit.log
+      CS_XML: pre-commit.xml
+    steps:
+      - run: sudo apt-get update && sudo apt-get install cppcheck
+        if: false
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v4
+        if: false
+        with:
+          cache: pip
+          python-version: 3.12.1
+      - run: python -m pip install pre-commit
+      - uses: actions/cache/restore@v4
+        with:
+          path: ~/.cache/pre-commit/
+          key: pre-commit-4|${{ env.pythonLocation }}|${{ hashFiles('.pre-commit-config.yaml')
+            }}
+      - name: Run pre-commit hooks
+        run: |
+          set -o pipefail
+          pre-commit gc
+          pre-commit run --show-diff-on-failure --color=always --all-files | tee ${RAW_LOG}
+      - name: Convert Raw Log to Annotations
+        uses: mdeweerd/[email protected]
+        if: ${{ failure() }}
+        with:
+          in: ${{ env.RAW_LOG }}
+      - uses: actions/cache/save@v4
+        if: ${{ always() }}
+        with:
+          path: ~/.cache/pre-commit/
+          key: pre-commit-4|${{ env.pythonLocation }}|${{ hashFiles('.pre-commit-config.yaml')
+            }}
+      - name: Provide log as artifact
+        uses: actions/upload-artifact@v4
+        if: ${{ always() }}
+        with:
+          name: precommit-logs
+          path: |
+            ${{ env.RAW_LOG }}
+            ${{ env.CS_XML }}
+          retention-days: 2

.github/workflows/validate-hacs.yml

@@ -0,0 +1,24 @@
+---
+name: Validate with hassfest
+
+on:
+  push:
+  pull_request:
+  schedule:
+    - cron: 0 0 * * *
+
+jobs:
+  validate:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: home-assistant/actions/hassfest@master
+  hacs:
+    name: HACS Action
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: HACS Action
+        uses: hacs/action@main
+        with:
+          category: integration

.pre-commit-config.yaml

@@ -1,4 +1,33 @@
+---
+files: ^(.*\.(py|json|md|sh|yaml|cfg|txt))$
+exclude: ^(\.[^/]*cache/.*|.*/_user.py|.github/logToCs.py)$
 repos:
+  - repo: https://github.com/verhovsky/pyupgrade-docs
+    rev: v0.3.0
+    hooks:
+      - id: pyupgrade-docs
+
+  - repo: https://github.com/executablebooks/mdformat
+    # Do this before other tools "fixing" the line endings
+    rev: 0.7.17
+    hooks:
+      - id: mdformat
+        name: Format Markdown
+        entry: mdformat  # Executable to run, with fixed options
+        language: python
+        types: [markdown]
+        args: [--wrap, '75', --number]
+        additional_dependencies:
+          - mdformat-toc
+          - mdformat-beautysh
+          # -mdformat-shfmt
+          # -mdformat-tables
+          - mdformat-config
+          - mdformat-black
+          - mdformat-web
+          - mdformat-gfm
+          - setuptools
+
   - repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v4.5.0
     hooks:
@@ -12,6 +41,10 @@ repos:
       - id: check-toml
       # - id: check-yaml
       - id: debug-statements
+      - id: check-executables-have-shebangs
+      - id: check-shebang-scripts-are-executable
+      - id: fix-byte-order-marker
+      - id: check-case-conflict
 
   - repo: https://github.com/asottile/pyupgrade
     rev: v3.15.0
@@ -20,7 +53,7 @@ repos:
         args: ['--py311-plus']
 
   - repo: https://github.com/pycqa/isort
-    rev: 5.13.0
+    rev: 5.13.2
     hooks:
       - id: isort
         args: ['--profile', 'black']
@@ -29,3 +62,80 @@ repos:
     rev: 23.12.1
     hooks:
       - id: black
+
+  - repo: https://github.com/adrienverge/yamllint.git
+    rev: v1.33.0
+    hooks:
+      - id: yamllint
+        args:
+          - --no-warnings
+          - -d
+          - '{extends: relaxed, rules: {line-length: {max: 90}}}'
+
+  - repo: https://github.com/asottile/pyupgrade
+    rev: v3.15.0
+    hooks:
+      - id: pyupgrade
+        args:
+          - --py310-plus
+
+  - repo: https://github.com/Lucas-C/pre-commit-hooks-bandit
+    rev: v1.0.6
+    hooks:
+      - id: python-bandit-vulnerability-check
+
+  - repo: https://github.com/fsouza/autoflake8
+    rev: v0.4.1
+    hooks:
+      - id: autoflake8
+        args:
+          - -i
+          - -r
+          - --expand-star-imports
+          - custom_components
+
+  - repo: https://github.com/PyCQA/flake8
+    rev: 6.1.0
+    hooks:
+      - id: flake8
+        additional_dependencies:
+          # - pyproject-flake8>=0.0.1a5
+          - flake8-bugbear>=22.7.1
+          - flake8-comprehensions>=3.10.1
+          - flake8-2020>=1.7.0
+          - mccabe>=0.7.0
+          - pycodestyle>=2.9.1
+          - pyflakes>=2.5.0
+
+  - repo: https://github.com/PyCQA/isort
+    rev: 5.13.2
+    hooks:
+      - id: isort
+
+  - repo: https://github.com/codespell-project/codespell
+    rev: v2.2.6
+    hooks:
+      - id: codespell
+        args:
+          # - --builtin=clear,rare,informal,usage,code,names,en-GB_to_en-US
+          - --builtin=clear,rare,informal,usage,code,names
+          - --ignore-words-list=hass,master
+          - --skip="./.*"
+          - --quiet-level=2
+  - repo: https://github.com/pylint-dev/pylint
+    rev: v3.0.3
+    hooks:
+      - id: pylint
+        additional_dependencies:
+          - homeassistant-stubs
+          - sqlalchemy
+          - pyyaml
+
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.7.1
+    hooks:
+      - id: mypy
+        additional_dependencies:
+          - homeassistant-stubs
+          - sqlalchemy
+          - pyyaml

custom_components/delorian/manifest.json

@@ -1,12 +1,10 @@
 {
   "domain": "delorian",
   "name": "Delorian - Testing integration for historical sensors",
+  "after_dependencies": ["recorder"],
   "codeowners": [
     "@ldotlopez"
   ],
-  "dependencies": [
-    "recorder"
-  ],
   "config_flow": true,
   "documentation": "https://github.com/ldotlopez/ha-historical-sensor",
   "iot_class": "cloud_polling",

hacs.json

@@ -0,0 +1,8 @@
+{
+  "name": "Delorian - Testing integration for historical sensors",
+  "content_in_root": false,
+  "zip_release": false,
+  "render_readme": true,
+  "persistent_directory": "local",
+  "homeassistant": "2023.1"
+}

homeassistant_historical_sensor/sensor.py

@@ -92,7 +92,7 @@ def should_poll(self) -> bool:
     def state(self):
         # Better report unavailable than anything
         #
-        # Another aproach is to return data from historical entity, but causes
+        # Another approach is to return data from historical entity, but causes
         # wrong results. Keep here for reference.
         #
         # HistoricalSensors doesn't use poll but state is accessed only once when

pyproject.toml

@@ -40,6 +40,14 @@ target-version = ['py311']
 [tool.isort]
 profile = "black"
 
+known_first_party = [
+    "homeassistant",
+    "tests",
+]
+forced_separate = [
+    "tests",
+]
+
 [tool.mypy]
 files = ['homeassistant_historical_sensor']
 
@@ -48,3 +56,31 @@ addopts = "--py311-plus"
 
 [tool.setuptools]
 packages = ["homeassistant_historical_sensor"]
+
+[tool.pylint.MAIN]
+py-version = "3.11"
+ignore = [
+    "tests",
+]
+persistent = false
+
+[tool.pylint.BASIC]
+class-const-naming-style = "any"
+good-names = [
+   "r",
+   "g",
+   "v",
+]
+
+[tool.pylint."MESSAGES CONTROL"]
+disable = [
+    "line-too-long",
+    "too-few-public-methods",
+    "missing-class-docstring",
+    "missing-function-docstring",
+    "missing-module-docstring",
+    "too-many-locals",
+]
+
+[tool.pylint.FORMAT]
+expected-line-ending-format = "LF"