carconnectivity-plugin-restapi 0.1a1__tar.gz

carconnectivity_plugin_restapi-0.1a1/.flake8

@@ -0,0 +1,2 @@
+[flake8]
+max-line-length=160

carconnectivity_plugin_restapi-0.1a1/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,33 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: bug
+assignees: tillsteinbach
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Logs**
+IF applicable logs that show the problem. Please take care to remove any confidential data from the logs (e.g. your vehicles VIN number, usernames or passwords)
+
+ - OS: [e.g. Windows, Linux, MacOS, ...]
+ - Version used [e.g. 0.6.2]
+
+**Additional context**
+Add any other context about the problem here.

carconnectivity_plugin_restapi-0.1a1/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: enhancement
+assignees: tillsteinbach
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

carconnectivity_plugin_restapi-0.1a1/.github/dependabot.yml

@@ -0,0 +1,11 @@
+version: 2
+updates:
+  # Maintain dependencies for GitHub Actions
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "daily"
+  - package-ecosystem: "pip"
+    directory: "/"
+    schedule:
+      interval: "daily"

carconnectivity_plugin_restapi-0.1a1/.github/workflows/build.yml

@@ -0,0 +1,59 @@
+name: Build Python Package
+
+# Controls when the action will run. 
+on:
+  # Triggers the workflow on push or pull request events but only for the master branch
+  push:
+    branches: [ main ]
+    tags:
+      - "v*"
+    paths:
+     - .github/workflows/build.yml
+     - '**.py'
+     - 'pyproject.toml'
+  pull_request:
+    paths:
+     - .github/workflows/build.yml
+     - '**.py'
+     - 'pyproject.toml'
+
+jobs:
+  build-python:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ['3.10', '3.11', '3.12', '3.13', '3.14']
+
+    steps:
+    - uses: actions/checkout@v6
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v6
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        if [ -f setup_requirements.txt ]; then pip install -r setup_requirements.txt; fi
+        python -m pip install build
+    - name: Build
+      run: |
+        python -m build
+    - name: Install built package
+      run: |
+        pip install dist/*.whl
+    - name: Run
+      run: |
+        set +e
+        output=$(carconnectivity test/integration_test/carConnectivity.json 2>&1)
+        echo "$output" | grep -q 'Invalid port specified in config ("port" out of range, must be 1-65535)'
+        if [ $? -ne 0 ]; then
+          echo "$output"
+          exit 1
+        fi
+        set -e
+    - name: Lint
+      run: |
+        make lint
+#    - name: Test
+#      run: |
+#        make test

carconnectivity_plugin_restapi-0.1a1/.github/workflows/build_and_publish.yml

@@ -0,0 +1,33 @@
+name: Build and Upload Python Package
+
+on:
+  push:
+    tags:
+      - "v*"
+
+jobs:
+  pypi-publish:
+    runs-on: ubuntu-latest
+    environment: 
+      name: pypi
+      url: https://pypi.org/p/carconnectivity-plugin-restapi
+    permissions:
+      id-token: write
+
+    steps:
+      - uses: actions/checkout@v6
+        with:
+          fetch-depth: 0
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: "3.x"
+      - name: Install dependencies
+        run: |
+            python -m pip install --upgrade pip
+            python -m pip install build twine
+      - name: Build
+        run: |
+          python -m build
+      - name: Publish package distributions to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

carconnectivity_plugin_restapi-0.1a1/.github/workflows/codeql-analysis.yml

@@ -0,0 +1,58 @@
+name: "CodeQL"
+
+on:
+  pull_request:
+    paths:
+       - '**.py'
+  schedule:
+    - cron: '33 5 * * 0'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'python' ]
+        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python' ]
+        # Learn more:
+        # https://docs.github.com/en/free-pro-team@latest/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#changing-the-languages-that-are-analyzed
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v6
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v4
+      with:
+        languages: ${{ matrix.language }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
+        # queries: ./path/to/local/query, your-org/your-repo/queries@main
+
+    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+    # If this step fails, then you should remove it and run the build manually (see below)
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v4
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 https://git.io/JvXDl
+
+    # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
+    #    and modify them (or add more) to build your code if your project
+    #    uses a compiled language
+
+    #- run: |
+    #   make bootstrap
+    #   make release
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v4

carconnectivity_plugin_restapi-0.1a1/.gitignore

@@ -0,0 +1,67 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# Version file generated by setuptools-scm
+src/carconnectivity_plugins/restapi/_version.py

carconnectivity_plugin_restapi-0.1a1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Till Steinbach
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

carconnectivity_plugin_restapi-0.1a1/Makefile

@@ -0,0 +1,18 @@
+BLUE='\033[0;34m'
+NC='\033[0m' # No Color
+
+test:
+	@pytest
+
+lint:
+	@echo "\n${BLUE}Running Pylint against source and test files...${NC}\n"
+	@pylint ./src
+	@echo "\n${BLUE}Running Flake8 against source and test files...${NC}\n"
+	@flake8
+	@echo "\n${BLUE}Running Bandit against source files...${NC}\n"
+	@bandit -c pyproject.toml -r .
+
+clean:
+	rm -rf .pytest_cache .coverage .pytest_cache coverage.xml coverage_html_report
+
+.PHONY: clean test

carconnectivity_plugin_restapi-0.1a1/PKG-INFO

@@ -0,0 +1,171 @@
+Metadata-Version: 2.4
+Name: carconnectivity-plugin-restapi
+Version: 0.1a1
+Summary: CarConnectivity plugin providing a REST API
+Author: Till Steinbach
+License-Expression: MIT
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: Intended Audience :: System Administrators
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Utilities
+Classifier: Topic :: System :: Monitoring
+Classifier: Topic :: Home Automation
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: carconnectivity>=0.11.6
+Requires-Dist: Werkzeug~=3.1.3
+Requires-Dist: Flask~=3.1.2
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
+Requires-Dist: pytest-mock; extra == "dev"
+Dynamic: license-file
+
+# CarConnectivity Plugin for a REST API
+
+[![GitHub sourcecode](https://img.shields.io/badge/Source-GitHub-green)](https://github.com/tillsteinbach/CarConnectivity-plugin-restapi/)
+[![GitHub](https://img.shields.io/github/license/tillsteinbach/CarConnectivity-plugin-restapi)](https://github.com/tillsteinbach/CarConnectivity-plugin-restapi/blob/master/LICENSE)
+[![GitHub issues](https://img.shields.io/github/issues/tillsteinbach/CarConnectivity-plugin-restapi)](https://github.com/tillsteinbach/CarConnectivity-plugin-restapi/issues)
+
+## CarConnectivity will become the successor of [WeConnect-python](https://github.com/tillsteinbach/WeConnect-python) in 2025 with similar functionality but support for other brands beyond Volkswagen!
+
+[CarConnectivity](https://github.com/tillsteinbach/CarConnectivity) is a python API to connect to various car services. This plugin provides a REST API that allows other clients to interact with CarConnectivity's object tree.
+
+## Supported operations
+- **GET** data from CarConnectivity's object tree
+- **PUT** writable attributes (change values)
+- **POST** commands with their arguments
+
+## Installation
+```bash
+pip install carconnectivity-plugin-restapi
+```
+
+## Configuration
+Add the plugin to your `carconnectivity.json` configuration file:
+
+```json
+{
+    "carConnectivity": {
+        "connectors": [...],
+        "plugins": [
+            {
+                "type": "restapi",
+                "config": {
+                    "host": "0.0.0.0",
+                    "port": 40000,
+                    "username": "admin",
+                    "password": "secretpassword"
+                }
+            }
+        ]
+    }
+}
+```
+
+### Multiple users
+```json
+{
+    "carConnectivity": {
+        "plugins": [
+            {
+                "type": "restapi",
+                "config": {
+                    "port": 40000,
+                    "users": [
+                        {"username": "user1", "password": "pass1"},
+                        {"username": "user2", "password": "pass2"}
+                    ]
+                }
+            }
+        ]
+    }
+}
+```
+
+### HTTPS
+```json
+{
+    "carConnectivity": {
+        "plugins": [
+            {
+                "type": "restapi",
+                "config": {
+                    "port": 40000,
+                    "https": true,
+                    "ssl_certificate_file": "/path/to/cert.pem",
+                    "ssl_certificate_key_file": "/path/to/key.pem",
+                    "username": "admin",
+                    "password": "secret"
+                }
+            }
+        ]
+    }
+}
+```
+
+## API Usage
+
+All endpoints require HTTP Basic Authentication.
+
+### GET — retrieve data
+```
+GET http://localhost:40000/<path>
+```
+Returns the object or attribute at `<path>` in the CarConnectivity object tree as JSON.
+An empty path (`/`) returns the entire tree.
+
+Example:
+```bash
+curl -u admin:secret http://localhost:40000/garage/WVWZZZAUZLW123456/charging/connector/connection_state
+```
+
+### PUT — set a writable attribute
+```
+PUT http://localhost:40000/<path>
+Content-Type: application/json
+
+{"value": <new_value>}
+```
+
+Example:
+```bash
+curl -u admin:secret -X PUT -H "Content-Type: application/json" \
+     -d '{"value": 80}' \
+     http://localhost:40000/garage/WVWZZZAUZLW123456/charging/settings/target_level
+```
+
+### POST — execute a command
+```
+POST http://localhost:40000/<path>
+Content-Type: application/json
+
+{"value": <command_arguments>}
+```
+
+Example:
+```bash
+curl -u admin:secret -X POST -H "Content-Type: application/json" \
+     -d '{"value": "start"}' \
+     http://localhost:40000/garage/WVWZZZAUZLW123456/climatization/commands/start-stop
+```
+
+## Configuration parameters
+
+| Parameter | Description | Default |
+|-----------|-------------|---------|
+| `host` | Host/IP to listen on | `0.0.0.0` |
+| `port` | Port to listen on | `40000` |
+| `username` | Single user username | — |
+| `password` | Single user password | — |
+| `users` | List of `{username, password}` objects | — |
+| `https` | Enable HTTPS | `false` |
+| `ssl_certificate_file` | Path to SSL certificate file | — |
+| `ssl_certificate_key_file` | Path to SSL private key file | — |
+| `log_level` | Log level (`DEBUG`, `INFO`, `WARNING`, `ERROR`) | `ERROR` |

carconnectivity_plugin_restapi-0.1a1/README.md

@@ -0,0 +1,142 @@
+# CarConnectivity Plugin for a REST API
+
+[![GitHub sourcecode](https://img.shields.io/badge/Source-GitHub-green)](https://github.com/tillsteinbach/CarConnectivity-plugin-restapi/)
+[![GitHub](https://img.shields.io/github/license/tillsteinbach/CarConnectivity-plugin-restapi)](https://github.com/tillsteinbach/CarConnectivity-plugin-restapi/blob/master/LICENSE)
+[![GitHub issues](https://img.shields.io/github/issues/tillsteinbach/CarConnectivity-plugin-restapi)](https://github.com/tillsteinbach/CarConnectivity-plugin-restapi/issues)
+
+## CarConnectivity will become the successor of [WeConnect-python](https://github.com/tillsteinbach/WeConnect-python) in 2025 with similar functionality but support for other brands beyond Volkswagen!
+
+[CarConnectivity](https://github.com/tillsteinbach/CarConnectivity) is a python API to connect to various car services. This plugin provides a REST API that allows other clients to interact with CarConnectivity's object tree.
+
+## Supported operations
+- **GET** data from CarConnectivity's object tree
+- **PUT** writable attributes (change values)
+- **POST** commands with their arguments
+
+## Installation
+```bash
+pip install carconnectivity-plugin-restapi
+```
+
+## Configuration
+Add the plugin to your `carconnectivity.json` configuration file:
+
+```json
+{
+    "carConnectivity": {
+        "connectors": [...],
+        "plugins": [
+            {
+                "type": "restapi",
+                "config": {
+                    "host": "0.0.0.0",
+                    "port": 40000,
+                    "username": "admin",
+                    "password": "secretpassword"
+                }
+            }
+        ]
+    }
+}
+```
+
+### Multiple users
+```json
+{
+    "carConnectivity": {
+        "plugins": [
+            {
+                "type": "restapi",
+                "config": {
+                    "port": 40000,
+                    "users": [
+                        {"username": "user1", "password": "pass1"},
+                        {"username": "user2", "password": "pass2"}
+                    ]
+                }
+            }
+        ]
+    }
+}
+```
+
+### HTTPS
+```json
+{
+    "carConnectivity": {
+        "plugins": [
+            {
+                "type": "restapi",
+                "config": {
+                    "port": 40000,
+                    "https": true,
+                    "ssl_certificate_file": "/path/to/cert.pem",
+                    "ssl_certificate_key_file": "/path/to/key.pem",
+                    "username": "admin",
+                    "password": "secret"
+                }
+            }
+        ]
+    }
+}
+```
+
+## API Usage
+
+All endpoints require HTTP Basic Authentication.
+
+### GET — retrieve data
+```
+GET http://localhost:40000/<path>
+```
+Returns the object or attribute at `<path>` in the CarConnectivity object tree as JSON.
+An empty path (`/`) returns the entire tree.
+
+Example:
+```bash
+curl -u admin:secret http://localhost:40000/garage/WVWZZZAUZLW123456/charging/connector/connection_state
+```
+
+### PUT — set a writable attribute
+```
+PUT http://localhost:40000/<path>
+Content-Type: application/json
+
+{"value": <new_value>}
+```
+
+Example:
+```bash
+curl -u admin:secret -X PUT -H "Content-Type: application/json" \
+     -d '{"value": 80}' \
+     http://localhost:40000/garage/WVWZZZAUZLW123456/charging/settings/target_level
+```
+
+### POST — execute a command
+```
+POST http://localhost:40000/<path>
+Content-Type: application/json
+
+{"value": <command_arguments>}
+```
+
+Example:
+```bash
+curl -u admin:secret -X POST -H "Content-Type: application/json" \
+     -d '{"value": "start"}' \
+     http://localhost:40000/garage/WVWZZZAUZLW123456/climatization/commands/start-stop
+```
+
+## Configuration parameters
+
+| Parameter | Description | Default |
+|-----------|-------------|---------|
+| `host` | Host/IP to listen on | `0.0.0.0` |
+| `port` | Port to listen on | `40000` |
+| `username` | Single user username | — |
+| `password` | Single user password | — |
+| `users` | List of `{username, password}` objects | — |
+| `https` | Enable HTTPS | `false` |
+| `ssl_certificate_file` | Path to SSL certificate file | — |
+| `ssl_certificate_key_file` | Path to SSL private key file | — |
+| `log_level` | Log level (`DEBUG`, `INFO`, `WARNING`, `ERROR`) | `ERROR` |