carconnectivity-plugin-database 0.1a11__tar.gz

carconnectivity_plugin_database-0.1a11/.flake8

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

carconnectivity_plugin_database-0.1a11/.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_database-0.1a11/.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_database-0.1a11/.github/dependabot.yml

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

carconnectivity_plugin_database-0.1a11/.github/workflows/build.yml

@@ -0,0 +1,63 @@
+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@v5
+    - 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 & sleep 5 ; kill $!)
+        echo "$output" | grep -q 'Database connection established successfully'
+        if [ $? -ne 0 ]; then
+          echo "$output"
+          exit 1
+        fi
+        set -e
+    - name: Lint
+      run: |
+        make lint
+#    - name: Test
+#      run: |
+#        make test
+
+
+
+

carconnectivity_plugin_database-0.1a11/.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-plugin-database
+    permissions:
+      id-token: write
+
+    steps:
+      - uses: actions/checkout@v5
+        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_database-0.1a11/.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@v5
+
+    # 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_database-0.1a11/.gitignore

@@ -0,0 +1,132 @@
+# 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
+
+_version.py

carconnectivity_plugin_database-0.1a11/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_plugin_database-0.1a11/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_database-0.1a11/PKG-INFO

@@ -0,0 +1,74 @@
+Metadata-Version: 2.4
+Name: carconnectivity-plugin-database
+Version: 0.1a11
+Summary: CarConnectivity plugin for storing data to Databases
+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.9.2
+Requires-Dist: sqlalchemy~=2.0.45
+Requires-Dist: psycopg2-binary~=2.9.11
+Requires-Dist: alembic~=1.17.2
+Requires-Dist: SQLAlchemy-Utc~=0.14.0
+Dynamic: license-file
+
+
+
+# CarConnectivity Plugin for Database storage
+[![GitHub sourcecode](https://img.shields.io/badge/Source-GitHub-green)](https://github.com/tillsteinbach/CarConnectivity-plugin-database/)
+[![GitHub release (latest by date)](https://img.shields.io/github/v/release/tillsteinbach/CarConnectivity-plugin-database)](https://github.com/tillsteinbach/CarConnectivity-plugin-database/releases/latest)
+[![GitHub](https://img.shields.io/github/license/tillsteinbach/CarConnectivity-plugin-database)](https://github.com/tillsteinbach/CarConnectivity-plugin-database/blob/master/LICENSE)
+[![GitHub issues](https://img.shields.io/github/issues/tillsteinbach/CarConnectivity-plugin-database)](https://github.com/tillsteinbach/CarConnectivity-plugin-database/issues)
+[![PyPI - Downloads](https://img.shields.io/pypi/dm/carconnectivity-plugin-database?label=PyPI%20Downloads)](https://pypi.org/project/carconnectivity-plugin-database/)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/carconnectivity-plugin-database)](https://pypi.org/project/carconnectivity-plugin-database/)
+[![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](https://github.com/tillsteinbach/CarConnectivity) is a python API to connect to various car services. If you want to store the data collected from your vehicle to a relational database (e.g. MySQL, PostgreSQL, or SQLite) this plugin will help you.
+
+### Install using PIP
+If you want to use the CarConnectivity Plugin for Databases, the easiest way is to obtain it from [PyPI](https://pypi.org/project/carconnectivity-plugin-database/). Just install it using:
+```bash
+pip3 install carconnectivity-plugin-database
+```
+after you installed CarConnectivity
+
+## Configuration
+In your carconnectivity.json configuration add a section for the database plugin like this. A documentation of all possible config options can be found [here](https://github.com/tillsteinbach/CarConnectivity-plugin-database/tree/main/doc/Config.md).
+```
+{
+    "carConnectivity": {
+        "connectors": [
+            ...
+        ]
+        "plugins": [
+            {
+                "type": "database",
+                "config": {
+                    "db_url": "sqlite:///carconnectivity.db"
+                }
+            }
+        ]
+    }
+}
+```
+
+## Updates
+If you want to update, the easiest way is:
+```bash
+pip3 install carconnectivity-plugin-database --upgrade
+```

carconnectivity_plugin_database-0.1a11/README.md

@@ -0,0 +1,46 @@
+
+
+# CarConnectivity Plugin for Database storage
+[![GitHub sourcecode](https://img.shields.io/badge/Source-GitHub-green)](https://github.com/tillsteinbach/CarConnectivity-plugin-database/)
+[![GitHub release (latest by date)](https://img.shields.io/github/v/release/tillsteinbach/CarConnectivity-plugin-database)](https://github.com/tillsteinbach/CarConnectivity-plugin-database/releases/latest)
+[![GitHub](https://img.shields.io/github/license/tillsteinbach/CarConnectivity-plugin-database)](https://github.com/tillsteinbach/CarConnectivity-plugin-database/blob/master/LICENSE)
+[![GitHub issues](https://img.shields.io/github/issues/tillsteinbach/CarConnectivity-plugin-database)](https://github.com/tillsteinbach/CarConnectivity-plugin-database/issues)
+[![PyPI - Downloads](https://img.shields.io/pypi/dm/carconnectivity-plugin-database?label=PyPI%20Downloads)](https://pypi.org/project/carconnectivity-plugin-database/)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/carconnectivity-plugin-database)](https://pypi.org/project/carconnectivity-plugin-database/)
+[![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](https://github.com/tillsteinbach/CarConnectivity) is a python API to connect to various car services. If you want to store the data collected from your vehicle to a relational database (e.g. MySQL, PostgreSQL, or SQLite) this plugin will help you.
+
+### Install using PIP
+If you want to use the CarConnectivity Plugin for Databases, the easiest way is to obtain it from [PyPI](https://pypi.org/project/carconnectivity-plugin-database/). Just install it using:
+```bash
+pip3 install carconnectivity-plugin-database
+```
+after you installed CarConnectivity
+
+## Configuration
+In your carconnectivity.json configuration add a section for the database plugin like this. A documentation of all possible config options can be found [here](https://github.com/tillsteinbach/CarConnectivity-plugin-database/tree/main/doc/Config.md).
+```
+{
+    "carConnectivity": {
+        "connectors": [
+            ...
+        ]
+        "plugins": [
+            {
+                "type": "database",
+                "config": {
+                    "db_url": "sqlite:///carconnectivity.db"
+                }
+            }
+        ]
+    }
+}
+```
+
+## Updates
+If you want to update, the easiest way is:
+```bash
+pip3 install carconnectivity-plugin-database --upgrade
+```

carconnectivity_plugin_database-0.1a11/doc/Config.md

@@ -0,0 +1,66 @@
+# CarConnectivity Plugin for Database storage Config Options
+The configuration for CarConnectivity is a .json file.
+## General format
+The general format is a `carConnectivity` section, followed by a list of connectors and plugins.
+In the `carConnectivity` section you can set the global `log_level`.
+Each connector or plugin needs a `type` attribute and a `config` section.
+The `type` and config options specific to your connector or plugin can be found on their respective project page.
+```json
+{
+    "carConnectivity": {
+        "log_level": "error", // set the global log level, you can set individual log levels in the connectors and plugins
+        "connectors": [
+            {
+                "type": "skoda", // Definition for a MySkoda account
+                "config": {
+                    "interval": 600, // Interval in which the server is checked in seconds
+                    "username": "test@test.de", // Username of your MySkoda Account
+                    "password": "testpassword123" // Password of your MySkoda Account
+                }
+            },
+            {
+                "type": "volkswagen", // Definition for a Volkswagen account
+                "config": {
+                    "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
+                }
+            }
+        ],
+        "plugins": [
+            {
+                "type": "database", // Minimal definition for the Database Connection
+                "config": {
+                    "db_url": "sqlite:///carconnectivity.db" // Database URL to connect to the database
+                }
+            }
+        ]
+    }
+}
+```
+### Database Plugin Options
+These are the valid options for the Database plugin
+```json
+{
+    "carConnectivity": {
+        "connectors": [],
+        "plugins": [
+            {
+                "type": "database", // Definition for the Database plugin
+                "disabled": false, // You can disable plugins without removing them from the config completely
+                "config": {
+                    "log_level": "error", // The log level for the plugin. Otherwise uses the global log level
+                    "db_url": "sqlite:///carconnectivity.db" // Database URL to connect to the database
+                }
+            }
+        ]
+    }
+}
+```
+
+### Connector Options
+Valid Options for connectors can be found here:
+* [CarConnectivity-connector-skoda Config Options](https://github.com/tillsteinbach/CarConnectivity-connector-skoda/tree/main/doc/Config.md)
+* [CarConnectivity-connector-volkswagen Config Options](https://github.com/tillsteinbach/CarConnectivity-connector-volkswagen/tree/main/doc/Config.md)
+* [CarConnectivity-connector-seatcupra Config Options](https://github.com/tillsteinbach/CarConnectivity-connector-seatcupra/tree/main/doc/Config.md)
+* [CarConnectivity-connector-tronity Config Options](https://github.com/tillsteinbach/CarConnectivity-connector-tronity/tree/main/doc/Config.md)

carconnectivity_plugin_database-0.1a11/pyproject.toml

@@ -0,0 +1,56 @@
+[build-system]
+requires = [
+    "setuptools>=61.0",
+    "setuptools_scm>=8"
+]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "carconnectivity-plugin-database"
+description = "CarConnectivity plugin for storing data to Databases"
+dynamic = ["version"]
+requires-python = ">=3.9"
+authors = [
+    { name = "Till Steinbach" }
+]
+dependencies = [
+    "carconnectivity>=0.9.2",
+    "sqlalchemy~=2.0.45",
+    "psycopg2-binary~=2.9.11",
+    "alembic~=1.17.2",
+    "SQLAlchemy-Utc~=0.14.0"
+]
+readme = "README.md"
+license = "MIT"
+license-files = [
+    "LICENSE",
+]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: End Users/Desktop",
+    "Intended Audience :: System Administrators",
+    "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",
+    "Programming Language :: Python :: 3.14",
+    "Topic :: Utilities",
+    "Topic :: System :: Monitoring",
+    "Topic :: Home Automation"
+]
+
+[project.urls]
+
+[project.scripts]
+carconnectivity-database = "carconnectivity_database.carconnectivity_database_base:main"
+
+[tool.setuptools_scm]
+write_to = "src/carconnectivity_plugins/database/_version.py"
+
+[tool.pylint.format]
+max-line-length = 160
+ignore-patterns= "_version.py"
+
+[tool.bandit]
+targets = "carconnectivity_plugins"

carconnectivity_plugin_database-0.1a11/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

carconnectivity_plugin_database-0.1a11/setup_requirements.txt

@@ -0,0 +1,7 @@
+flake8~=7.3.0
+pylint~=4.0.2
+bandit~=1.8.6
+
+# For UI only
+Flask~=3.1.2
+flask-login~=0.6.3