python-openevse-http 0.3.4__tar.gz → 0.4.0__tar.gz

python_openevse_http-0.4.0/.github/dependabot.yml

@@ -0,0 +1,16 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://help.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: "pip"      # See documentation for possible values
+    directory: "/"                # Location of package manifests
+    schedule:
+      interval: "daily"
+
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "daily"

python_openevse_http-0.4.0/.github/release-drafter.yml

@@ -0,0 +1,103 @@
+name-template: "$RESOLVED_VERSION"
+tag-template: "$RESOLVED_VERSION"
+change-template: "- $TITLE @$AUTHOR (#$NUMBER)"
+sort-direction: ascending
+categories:
+  - title: "💥 Breaking Change 💥"
+    labels:
+      - "breaking-change"
+      - "breaking change"
+  - title: "✨ New Features ✨"
+    labels:
+      - "enhancement"
+      - "feature"
+  - title: "🐛 Bug Fixes 🐛"
+    labels:
+      - "fix"
+      - "bugfix"
+      - "bug"
+  - title: "⚡ Performance ⚡"
+    labels:
+      - "performance"
+  - title: "🔧 Maintenance 🔧"
+    labels:
+      - "chore"
+      - "documentation"
+      - "maintenance"
+      - "repo"
+      - "dependencies"
+      - "github_actions"
+      - "refactor"
+      - "style"
+      - "build"
+      - "revert"
+  - title: "🎓 Code Quality 🎓"
+    labels:
+      - "code-quality"
+      - "CI"
+      - "test"
+autolabeler:
+  - label: "breaking-change"
+    title:
+      - '/^[a-z]+(\([^)]+\))?!:/i'
+  - label: "feature"
+    title:
+      - '/^feat(\([^)]+\))?:/i'
+  - label: "bugfix"
+    title:
+      - '/^fix(\([^)]+\))?:/i'
+  - label: "refactor"
+    title:
+      - '/^refactor(\([^)]+\))?:/i'
+  - label: "code-quality"
+    title:
+      - '/^test(\([^)]+\))?:/i'
+  - label: "CI"
+    title:
+      - '/^ci(\([^)]+\))?:/i'
+  - label: "chore"
+    title:
+      - '/^chore(\([^)]+\))?:/i'
+  - label: "documentation"
+    title:
+      - '/^docs(\([^)]+\))?:/i'
+  - label: "style"
+    title:
+      - '/^style(\([^)]+\))?:/i'
+  - label: "performance"
+    title:
+      - '/^perf(\([^)]+\))?:/i'
+  - label: "revert"
+    title:
+      - '/^revert(\([^)]+\))?:/i'
+  - label: "build"
+    title:
+      - '/^build(\([^)]+\))?:/i'
+version-resolver:
+  major:
+    labels:
+      - "breaking-change"
+      - "breaking change"
+  minor:
+    labels:
+      - "feature"
+      - "enhancement"
+  patch:
+    labels:
+      - "bug"
+      - "fix"
+      - "bugfix"
+      - "performance"
+      - "refactor"
+      - "style"
+      - "build"
+      - "chore"
+      - "documentation"
+      - "CI"
+      - "test"
+      - "code-quality"
+      - "revert"
+  default: patch
+template: |
+  ## What’s Changed
+  $CHANGES

python_openevse_http-0.4.0/.github/workflows/autolabeler.yml

@@ -0,0 +1,41 @@
+name: Autolabeler
+
+on:
+  pull_request:
+    types:
+      - opened
+      - synchronize
+      - reopened
+  pull_request_target:
+    types:
+      - opened
+      - synchronize
+      - reopened
+
+permissions: {}
+
+concurrency:
+  group: ${{ format('al-{0}-pr-{1}', github.event_name, github.event.pull_request.number) }}
+  cancel-in-progress: true
+
+jobs:
+  autolabel:
+    name: Autolabel PR
+    # Run on pull_request_target for forks, pull_request for
+    # same-repo PRs to prevent duplicate runs.
+    if: >
+      (github.event_name == 'pull_request_target' && github.event.pull_request.head.repo.fork) ||
+      (github.event_name == 'pull_request' && !github.event.pull_request.head.repo.fork)
+    permissions:
+      contents: read
+      pull-requests: write
+    runs-on: ubuntu-latest
+    timeout-minutes: 3
+    steps:
+      - uses: step-security/harden-runner@fe104658747b27e96e4f7e80cd0a94068e53901d  # v2.16.1
+        with:
+          egress-policy: audit
+
+      - uses: release-drafter/release-drafter/autolabeler@693d20e7c1ce1a81d3a41962f85914253b518449  # v7
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

python_openevse_http-0.4.0/.github/workflows/links.yml

@@ -0,0 +1,27 @@
+name: Links
+
+on:
+  push:
+    branches: ["main", "dev"]
+  pull_request:
+    branches: ["main", "dev"]
+  schedule:
+    - cron: "0 0 * * 1"
+
+permissions:
+  contents: read
+
+jobs:
+  linkChecker:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: step-security/harden-runner@fe104658747b27e96e4f7e80cd0a94068e53901d  # v2.16.1
+        with:
+          egress-policy: audit
+
+      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd  # v6
+
+      - name: Link Checker
+        uses: lycheeverse/lychee-action@8646ba30535128ac92d33dfc9133794bfdd9b411  # v2
+        with:
+          args: --verbose --no-progress './**/*.md'

python_openevse_http-0.4.0/.github/workflows/publish-to-pypi.yml

@@ -0,0 +1,46 @@
+name: Publish releases to PyPI
+
+on:
+  release:
+    types: [published, prereleased]
+  workflow_dispatch:
+    inputs:
+      tag:
+        description: 'Tag/Ref to build and publish'
+        required: false
+        default: ''
+
+permissions:
+  contents: read
+
+jobs:
+  build-and-publish:
+    name: Builds and publishes releases to PyPI
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      id-token: write
+    steps:
+      - uses: step-security/harden-runner@fe104658747b27e96e4f7e80cd0a94068e53901d  # v2.16.1
+        with:
+          egress-policy: audit
+
+      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd  # v6
+        with:
+          ref: ${{ inputs.tag || github.ref }}
+          fetch-depth: 0
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@1edb52594c857e2b5b13128931090f0640537287  # v5.3.0
+        with:
+          enable-cache: true
+          version: "0.10.9"
+
+      - name: Set up Python
+        run: uv python install 3.14
+
+      - name: Build package
+        run: uv build
+
+      - name: Publish release to PyPI
+        uses: pypa/gh-action-pypi-publish@76f52bc884231f62b9a034ebfe128415bbaabdfc  # v1.12.4

python_openevse_http-0.4.0/.github/workflows/release-drafter.yml

@@ -0,0 +1,23 @@
+name: Release Drafter
+
+on:
+  push:
+    branches:
+      - main
+
+permissions:
+  contents: write
+  pull-requests: read
+
+jobs:
+  update_release_draft:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: step-security/harden-runner@fe104658747b27e96e4f7e80cd0a94068e53901d  # v2.16.1
+        with:
+          egress-policy: audit
+
+      # Drafts your next Release notes as Pull Requests are merged into "main"
+      - uses: release-drafter/release-drafter@693d20e7c1ce1a81d3a41962f85914253b518449  # v7
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

python_openevse_http-0.4.0/.github/workflows/test.yml

@@ -0,0 +1,87 @@
+# This workflow will install Python dependencies, run tests and lint
+
+name: Test
+
+on:
+  push:
+    branches:
+      - main
+      - dev
+  pull_request:
+    branches:
+      - main
+      - dev
+
+permissions: read-all
+
+jobs:
+  prek:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: step-security/harden-runner@fe104658747b27e96e4f7e80cd0a94068e53901d  # v2.16.1
+        with:
+          egress-policy: audit
+
+      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd  # v6
+      - name: Set up Python
+        uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405  # v6
+        with:
+          python-version: "3.14"
+      - name: Install prek
+        run: pip install prek==0.4.0
+      - name: Run prek
+        run: prek run --all-files --skip no-commit-to-branch
+  build:
+    runs-on: ubuntu-latest
+    needs: prek
+    strategy:
+      matrix:
+        python-version:
+          - "3.13"
+          - "3.14"
+
+    steps:
+      - uses: step-security/harden-runner@fe104658747b27e96e4f7e80cd0a94068e53901d  # v2.16.1
+        with:
+          egress-policy: audit
+
+      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd  # v6
+        with:
+          fetch-depth: 2
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405  # v6
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install tox tox-gh-actions
+      - name: Test with tox
+        run: tox
+      - name: Upload coverage data
+        if: ${{ matrix.python-version == '3.14' }}
+        uses: "actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a"  # v7
+        with:
+          name: coverage-data
+          path: "coverage.xml"
+
+  coverage:
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - uses: step-security/harden-runner@fe104658747b27e96e4f7e80cd0a94068e53901d  # v2.16.1
+        with:
+          egress-policy: audit
+
+      - name: Check out the repository
+        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd  # v6
+        with:
+          fetch-depth: 2
+      - name: Download coverage data
+        uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c  # v8
+        with:
+          name: coverage-data
+      - name: Upload coverage report
+        uses: codecov/codecov-action@e79a6962e0d4c0c17b229090214935d2e33f8354  # v6
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}

python_openevse_http-0.4.0/.gitignore

@@ -0,0 +1,102 @@
+# Hide sublime text stuff
+*.sublime-project
+*.sublime-workspace
+
+# Hide some OS X stuff
+.DS_Store
+.AppleDouble
+.LSOverride
+Icon
+
+# Thumbnails
+._*
+
+# IntelliJ IDEA
+.idea
+*.iml
+
+# pytest
+.pytest_cache
+.cache
+
+# GITHUB Proposed Python stuff:
+*.py[cod]
+
+# C extensions
+*.so
+
+# Packages
+*.egg
+*.egg-info
+dist
+build
+eggs
+.eggs
+parts
+bin
+var
+sdist
+develop-eggs
+.installed.cfg
+lib
+lib64
+pip-wheel-metadata
+
+# Logs
+*.log
+pip-log.txt
+
+# Unit test / coverage reports
+.coverage
+.tox
+coverage.xml
+nosetests.xml
+htmlcov/
+test-reports/
+test-results.xml
+test-output.xml
+
+# Translations
+*.mo
+
+# Mr Developer
+.mr.developer.cfg
+.project
+.pydevproject
+
+.python-version
+
+# emacs auto backups
+*~
+*#
+*.orig
+
+# venv stuff
+pyvenv.cfg
+pip-selfcheck.json
+venv
+.venv
+Pipfile*
+share/*
+Scripts/
+
+# vimmy stuff
+*.swp
+*.swo
+tags
+ctags.tmp
+
+# vagrant stuff
+virtualization/vagrant/setup_done
+virtualization/vagrant/.vagrant
+virtualization/vagrant/config
+
+# Visual Studio Code
+.vscode/*
+!.vscode/cSpell.json
+!.vscode/extensions.json
+!.vscode/tasks.json
+
+# Typing
+.mypy_cache
+*.pyc

python_openevse_http-0.4.0/.pre-commit-config.yaml

@@ -0,0 +1,50 @@
+# .pre-commit-config.yaml
+default_install_hook_types: [pre-commit, pre-push]
+
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.9.7
+    hooks:
+      - id: ruff
+        args: [--fix]
+      - id: ruff-format
+
+  - repo: https://github.com/codespell-project/codespell
+    rev: v2.4.1
+    hooks:
+      - id: codespell
+        args:
+          - --ignore-words-list=hass,alot,datas,dof,dur,farenheit,hist,iff,ines,ist,lightsensor,mut,nd,pres,referer,ser,serie,te,technik,ue,uint,visability,wan,wanna,withing,iam,incomfort
+          - --skip="./.*,*.csv,*.json"
+          - --quiet-level=2
+        exclude_types: [csv, json]
+
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-yaml
+      - id: debug-statements
+      - id: check-docstring-first
+      - id: no-commit-to-branch
+        args: [--branch=main]
+      - id: check-executables-have-shebangs
+        stages: [manual]
+
+  - repo: https://github.com/adrienverge/yamllint.git
+    rev: v1.35.1
+    hooks:
+      - id: yamllint
+
+  - repo: https://github.com/prettier/prettier
+    rev: 2.0.4
+    hooks:
+      - id: prettier
+        stages: [manual]
+
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.15.0
+    hooks:
+      - id: mypy
+        files: ^openevsehttp/.+\.py$

python_openevse_http-0.4.0/.yamllint

@@ -0,0 +1,60 @@
+ignore: |
+  release-drafter.yml
+rules:
+  braces:
+    level: error
+    min-spaces-inside: 0
+    max-spaces-inside: 1
+    min-spaces-inside-empty: -1
+    max-spaces-inside-empty: -1
+  brackets:
+    level: error
+    min-spaces-inside: 0
+    max-spaces-inside: 0
+    min-spaces-inside-empty: -1
+    max-spaces-inside-empty: -1
+  colons:
+    level: error
+    max-spaces-before: 0
+    max-spaces-after: 1
+  commas:
+    level: error
+    max-spaces-before: 0
+    min-spaces-after: 1
+    max-spaces-after: 1
+  comments:
+    level: error
+    require-starting-space: true
+    min-spaces-from-content: 2
+  comments-indentation:
+    level: error
+  document-end:
+    level: error
+    present: false
+  document-start:
+    level: error
+    present: false
+  empty-lines:
+    level: error
+    max: 1
+    max-start: 0
+    max-end: 1
+  hyphens:
+    level: error
+    max-spaces-after: 1
+  indentation:
+    level: error
+    spaces: 2
+    indent-sequences: true
+    check-multi-line-strings: false
+  key-duplicates:
+    level: error
+  line-length: disable
+  new-line-at-end-of-file:
+    level: error
+  new-lines:
+    level: error
+    type: unix
+  trailing-spaces:
+    level: error
+  truthy: disable

python_openevse_http-0.4.0/EXTERNAL_SESSION.md

@@ -0,0 +1,141 @@
+# External Session Management
+
+## Overview
+
+The `python-openevse-http` library now supports passing an external `aiohttp.ClientSession` to the `OpenEVSE` class. This allows you to manage the session lifecycle yourself and share sessions across multiple API clients.
+
+## Benefits
+
+- **Session Reuse**: Share a single session across multiple OpenEVSE instances or other aiohttp-based clients
+- **Custom Configuration**: Configure session settings like timeouts, connectors, and SSL verification
+- **Resource Management**: Better control over connection pooling and resource cleanup
+- **Integration**: Easier integration with existing applications that already manage aiohttp sessions
+
+## Usage
+
+### With External Session
+
+```python
+import aiohttp
+from openevsehttp import OpenEVSE
+
+async def main():
+    # Create your own session with custom settings
+    timeout = aiohttp.ClientTimeout(total=30)
+    async with aiohttp.ClientSession(timeout=timeout) as session:
+        # Pass the session to OpenEVSE
+        charger = OpenEVSE("openevse.local", session=session)
+
+        # Use the charger normally
+        await charger.update()
+        print(f"Status: {charger.status}")
+
+        # Clean up
+        await charger.ws_disconnect()
+        # Session will be closed by the context manager
+```
+
+### Without External Session (Backward Compatible)
+
+```python
+from openevsehttp import OpenEVSE
+
+async def main():
+    # The library creates and manages its own sessions
+    charger = OpenEVSE("openevse.local")
+
+    # Use the charger normally
+    await charger.update()
+    print(f"Status: {charger.status}")
+
+    await charger.ws_disconnect()
+```
+
+### Sharing a Session
+
+```python
+import aiohttp
+from openevsehttp import OpenEVSE
+
+async def main():
+    async with aiohttp.ClientSession() as session:
+        # Use the same session for multiple chargers
+        charger1 = OpenEVSE("charger1.local", session=session)
+        charger2 = OpenEVSE("charger2.local", session=session)
+
+        # Both chargers use the same session
+        await charger1.update()
+        await charger2.update()
+
+        await charger1.ws_disconnect()
+        await charger2.ws_disconnect()
+```
+
+## API Changes
+
+### `OpenEVSE.__init__()`
+
+```python
+def __init__(
+    self,
+    host: str,
+    user: str = "",
+    pwd: str = "",
+    session: aiohttp.ClientSession | None = None,
+) -> None:
+```
+
+**Parameters:**
+- `host` (str): The hostname or IP address of the OpenEVSE charger
+- `user` (str, optional): Username for authentication
+- `pwd` (str, optional): Password for authentication
+- `session` (aiohttp.ClientSession | None, optional): External session to use for HTTP requests. If not provided, the library will create temporary sessions as needed.
+
+### `OpenEVSEWebsocket.__init__()`
+
+```python
+def __init__(
+    self,
+    server,
+    callback,
+    user=None,
+    password=None,
+    session: aiohttp.ClientSession | None = None,
+):
+```
+
+**Parameters:**
+- `server`: The server URL
+- `callback`: Callback function for websocket events
+- `user` (optional): Username for authentication
+- `password` (optional): Password for authentication
+- `session` (aiohttp.ClientSession | None, optional): External session to use for websocket connections. If not provided, a new session will be created.
+
+## Important Notes
+
+1. **Session Lifecycle**: When you provide an external session, you are responsible for closing it. The library will NOT close externally provided sessions.
+
+2. **Backward Compatibility**: This change is fully backward compatible. Existing code that doesn't provide a session will continue to work exactly as before.
+
+3. **Websocket Sessions**: The websocket connection will also use the provided session, ensuring consistent session management across all HTTP and WebSocket operations.
+
+4. **Thread Safety**: If you're using the same session across multiple OpenEVSE instances, ensure you're following aiohttp's thread safety guidelines.
+
+## Migration Guide
+
+If you want to migrate existing code to use external sessions:
+
+**Before:**
+```python
+charger = OpenEVSE("openevse.local")
+await charger.update()
+```
+
+**After:**
+```python
+async with aiohttp.ClientSession() as session:
+    charger = OpenEVSE("openevse.local", session=session)
+    await charger.update()
+```
+
+No other changes are required!