carconnectivity-connector-skoda 0.1__tar.gz

carconnectivity_connector_skoda-0.1/.flake8

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

carconnectivity_connector_skoda-0.1/.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_connector_skoda-0.1/.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_connector_skoda-0.1/.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_connector_skoda-0.1/.github/workflows/build.yml

@@ -0,0 +1,53 @@
+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.9', '3.10', '3.11', '3.12', '3.13']
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v5
+      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: Lint
+      run: |
+        make lint
+#    - name: Test
+#      run: |
+#        make test
+
+
+
+

carconnectivity_connector_skoda-0.1/.github/workflows/build_and_publish.yml

@@ -0,0 +1,37 @@
+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-connector-skoda
+    permissions:
+      id-token: write
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        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_connector_skoda-0.1/.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@v4
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v3
+      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@v3
+
+    # ℹ️ 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@v3

carconnectivity_connector_skoda-0.1/.gitignore

@@ -0,0 +1,131 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# 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
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.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/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+.DS_Store
+src/carconnectivity_connectors/skoda/_version.py

carconnectivity_connector_skoda-0.1/CHANGELOG.md

@@ -0,0 +1,14 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## [Unreleased]
+- No unreleased changes so far
+
+## [0.1] - 2025-01-25
+Initial release, let's go and give this to the public to try out...
+The API is not yet implemented completely but most functions already work
+
+[unreleased]: https://github.com/tillsteinbach/CarConnectivity-connector-skoda/compare/v0.1...HEAD
+
+[0.1]: https://github.com/tillsteinbach/CarConnectivity-connector-skoda/releases/tag/v0.1

carconnectivity_connector_skoda-0.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 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_connector_skoda-0.1/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_connector_skoda-0.1/PKG-INFO

@@ -0,0 +1,123 @@
+Metadata-Version: 2.2
+Name: carconnectivity-connector-skoda
+Version: 0.1
+Summary: CarConnectivity connector for Skoda services
+Author: Till Steinbach
+License: MIT License
+        
+        Copyright (c) 2021 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.
+        
+Classifier: Development Status :: 3 - Alpha
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Intended Audience :: Developers
+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: Topic :: Software Development :: Libraries
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: carconnectivity~=0.1.0
+Requires-Dist: oauthlib~=3.2.2
+Requires-Dist: requests~=2.32.3
+Requires-Dist: jwt~=1.3.1
+
+
+
+# CarConnectivity Connector for Volkswagen Vehicles
+[![GitHub sourcecode](https://img.shields.io/badge/Source-GitHub-green)](https://github.com/tillsteinbach/CarConnectivity-connector-skoda/)
+[![GitHub release (latest by date)](https://img.shields.io/github/v/release/tillsteinbach/CarConnectivity-connector-skoda)](https://github.com/tillsteinbach/CarConnectivity-connector-skoda/releases/latest)
+[![GitHub](https://img.shields.io/github/license/tillsteinbach/CarConnectivity-connector-skoda)](https://github.com/tillsteinbach/CarConnectivity-connector-skoda/blob/master/LICENSE)
+[![GitHub issues](https://img.shields.io/github/issues/tillsteinbach/CarConnectivity-connector-skoda)](https://github.com/tillsteinbach/CarConnectivity-connector-skoda/issues)
+[![PyPI - Downloads](https://img.shields.io/pypi/dm/carconnectivity-connector-skoda?label=PyPI%20Downloads)](https://pypi.org/project/carconnectivity-connector-skoda/)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/carconnectivity-connector-skoda)](https://pypi.org/project/carconnectivity-connector-skoda/)
+[![Donate at PayPal](https://img.shields.io/badge/Donate-PayPal-2997d8)](https://www.paypal.com/donate?hosted_button_id=2BVFF5GJ9SXAJ)
+[![Sponsor at Github](https://img.shields.io/badge/Sponsor-GitHub-28a745)](https://github.com/sponsors/tillsteinbach)
+
+## 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 connector enables the integration of skoda vehicles through the WeConnect API. Look at [CarConnectivity](https://github.com/tillsteinbach/CarConnectivity) for other supported brands.
+
+## Configuration
+In your carconnectivity.json configuration add a section for the skoda connector like this:
+```
+{
+    "carConnectivity": {
+        "connectors": [
+            {
+                "type": "skoda",
+                "config": {
+                    "username": "test@test.de",
+                    "password": "testpassword123"
+                }
+            }
+        ]
+    }
+}
+```
+### Credentials
+If you do not want to provide your username or password inside the configuration you have to create a ".netrc" file at the appropriate location (usually this is your home folder):
+```
+# For WeConnect
+machine skoda
+login test@test.de
+password testpassword123
+```
+In this case the configuration needs to look like this:
+```
+{
+    "carConnectivity": {
+        "connectors": [
+            {
+                "type": "skoda",
+                "config": {
+                }
+            }
+        ]
+    }
+}
+```
+
+You can also provide the location of the netrc file in the configuration.
+```
+{
+    "carConnectivity": {
+        "connectors": [
+            {
+                "type": "skoda",
+                "config": {
+                    "netrc": "/some/path/on/your/filesystem"
+                }
+            }
+        ]
+    }
+}
+```
+The optional S-PIN needed for some commands can be provided in the account section of the netrc:
+```
+# For WeConnect
+machine skoda
+login test@test.de
+password testpassword123
+account 1234
+```

carconnectivity_connector_skoda-0.1/README.md

@@ -0,0 +1,79 @@
+
+
+# CarConnectivity Connector for Volkswagen Vehicles
+[![GitHub sourcecode](https://img.shields.io/badge/Source-GitHub-green)](https://github.com/tillsteinbach/CarConnectivity-connector-skoda/)
+[![GitHub release (latest by date)](https://img.shields.io/github/v/release/tillsteinbach/CarConnectivity-connector-skoda)](https://github.com/tillsteinbach/CarConnectivity-connector-skoda/releases/latest)
+[![GitHub](https://img.shields.io/github/license/tillsteinbach/CarConnectivity-connector-skoda)](https://github.com/tillsteinbach/CarConnectivity-connector-skoda/blob/master/LICENSE)
+[![GitHub issues](https://img.shields.io/github/issues/tillsteinbach/CarConnectivity-connector-skoda)](https://github.com/tillsteinbach/CarConnectivity-connector-skoda/issues)
+[![PyPI - Downloads](https://img.shields.io/pypi/dm/carconnectivity-connector-skoda?label=PyPI%20Downloads)](https://pypi.org/project/carconnectivity-connector-skoda/)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/carconnectivity-connector-skoda)](https://pypi.org/project/carconnectivity-connector-skoda/)
+[![Donate at PayPal](https://img.shields.io/badge/Donate-PayPal-2997d8)](https://www.paypal.com/donate?hosted_button_id=2BVFF5GJ9SXAJ)
+[![Sponsor at Github](https://img.shields.io/badge/Sponsor-GitHub-28a745)](https://github.com/sponsors/tillsteinbach)
+
+## 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 connector enables the integration of skoda vehicles through the WeConnect API. Look at [CarConnectivity](https://github.com/tillsteinbach/CarConnectivity) for other supported brands.
+
+## Configuration
+In your carconnectivity.json configuration add a section for the skoda connector like this:
+```
+{
+    "carConnectivity": {
+        "connectors": [
+            {
+                "type": "skoda",
+                "config": {
+                    "username": "test@test.de",
+                    "password": "testpassword123"
+                }
+            }
+        ]
+    }
+}
+```
+### Credentials
+If you do not want to provide your username or password inside the configuration you have to create a ".netrc" file at the appropriate location (usually this is your home folder):
+```
+# For WeConnect
+machine skoda
+login test@test.de
+password testpassword123
+```
+In this case the configuration needs to look like this:
+```
+{
+    "carConnectivity": {
+        "connectors": [
+            {
+                "type": "skoda",
+                "config": {
+                }
+            }
+        ]
+    }
+}
+```
+
+You can also provide the location of the netrc file in the configuration.
+```
+{
+    "carConnectivity": {
+        "connectors": [
+            {
+                "type": "skoda",
+                "config": {
+                    "netrc": "/some/path/on/your/filesystem"
+                }
+            }
+        ]
+    }
+}
+```
+The optional S-PIN needed for some commands can be provided in the account section of the netrc:
+```
+# For WeConnect
+machine skoda
+login test@test.de
+password testpassword123
+account 1234
+```

carconnectivity_connector_skoda-0.1/doc/Config.md

@@ -0,0 +1,29 @@
+
+
+# CarConnectivity Connector for MySkoda Config Options
+The configuration for CarConnectivity is a .json file.
+## MySkoda Connector Options
+These are the valid options for the MySkoda Connector
+```json
+{
+    "carConnectivity": {
+        "connectors": [
+            {
+                "type": "skoda", // Definition for the MySkoda Connector
+                "disabled": false, // You can disable connectors without removing them from the config completely
+                "config": {
+                    "log_level": "error", // set the connectos log level
+                    "interval": 300, // Interval in which the server is checked in seconds
+                    "username": "test@test.de", // Username of your Volkswagen Account
+                    "password": "testpassword123", // Username of your Volkswagen Account
+                    "spin": 1234, //S-Pin used for some special commands like locking/unlocking
+                    "netrc": "~/.netr", // netrc file if to be used for passwords
+                    "api_log_level": "debug", // Show debug information regarding the API
+                    "max_age": 300 //Cache requests to the server vor MAX_AGE seconds
+                }
+            }
+        ],
+        "plugins": []
+    }
+}
+```

carconnectivity_connector_skoda-0.1/pyproject.toml

@@ -0,0 +1,46 @@
+[build-system]
+requires = [
+    "setuptools>=61.0",
+    "setuptools_scm>=8"
+]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "carconnectivity-connector-skoda"
+description = "CarConnectivity connector for Skoda services"
+dynamic = ["version"]
+requires-python = ">=3.8"
+authors = [
+    { name = "Till Steinbach" }
+]
+dependencies = [
+    "carconnectivity~=0.1.0",
+    "oauthlib~=3.2.2",
+    "requests~=2.32.3",
+    "jwt~=1.3.1"
+]
+readme = "README.md"
+license = { file = "LICENSE" }
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "License :: OSI Approved :: MIT License",
+    "Intended Audience :: Developers",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Software Development :: Libraries"
+]
+
+[project.urls]
+
+[tool.setuptools_scm]
+write_to = "src/carconnectivity_connectors/skoda/_version.py"
+
+[tool.pylint.format]
+max-line-length = 160
+ignore-patterns= "_version.py"
+
+[tool.bandit]
+targets = "carconnectivity_cli"