sovd-server 1.0.0__tar.gz

sovd_server-1.0.0/MANIFEST.in

@@ -0,0 +1,3 @@
+# Include requirements so setup.py can read it when building from sdist
+include requirements.txt
+include README.md

sovd_server-1.0.0/PKG-INFO

@@ -0,0 +1,263 @@
+Metadata-Version: 2.4
+Name: sovd-server
+Version: 1.0.0
+Summary: SOVD (Service-Oriented Vehicle Data) Server Implementation
+Home-page: https://github.com/sovd/sovd-server
+Author: SOVD Development Team
+Author-email: SOVD Development Team <dev@sovd.org>
+License: MIT
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+Requires-Dist: flask>=3.1.0
+Requires-Dist: flask-cors>=3.0.0
+Requires-Dist: pyyaml>=6.0
+Requires-Dist: connexion[swagger-ui]<=3.3.0,>=3.0.0
+Requires-Dist: jsonschema>=4.0.0
+Provides-Extra: dev
+Requires-Dist: pytest>=8.4.2; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"
+Requires-Dist: black; extra == "dev"
+Requires-Dist: flake8; extra == "dev"
+Requires-Dist: mypy; extra == "dev"
+Requires-Dist: bandit; extra == "dev"
+Requires-Dist: safety; extra == "dev"
+Dynamic: author
+Dynamic: home-page
+Dynamic: requires-python
+
+# SOVD Server with YAML Configuration
+
+This project implements a Service-Oriented Vehicle Diagnostics (SOVD) server based on ISO/DIS 17978-3:2025 with YAML-based configuration support.
+
+## Features
+
+- **Hierarchical YAML Configuration**: Multi-level configuration system with gateway, entity, and resource configurations
+- **Real Data Endpoints**: Actual data for data resources, operations, faults, and modes
+- **No Authentication**: Simplified setup without authorization layer for testing
+- **RESTful API**: Full SOVD API implementation with proper JSON responses
+- **Configurable Entities**: Support for areas, components, and applications
+- **Resource Management**: Data resources, operations, faults, modes, and configurations
+
+## Project Structure
+
+```
+sovd_server/
+├── src/
+│   └── sovd_server/               # Main source code
+│       ├── config/                # Configuration files
+│       │   ├── sovd_gateway.yaml  # Main gateway configuration
+│       │   ├── entities/          # Entity configurations
+│       │   │   ├── areas.yaml
+│       │   │   ├── components.yaml
+│       │   │   └── apps.yaml
+│       │   └── resources/         # Resource configurations
+│       │       ├── data/          # Data resource configs
+│       │       ├── operations/    # Operation configs
+│       │       ├── faults/        # Fault configs
+│       │       └── modes/         # Mode configs
+│       ├── enhanced_server.py     # Enhanced server with YAML support
+│       ├── config_loader.py       # YAML configuration loader
+│       └── run_enhanced_server.py # Server runner script
+├── tests/                         # Test files
+│   ├── test_config.py             # Configuration testing
+│   ├── test_endpoints.py          # Endpoint testing
+│   └── debug_*.py                 # Debug utilities
+├── generated/                     # Auto-generated SOVD server
+├── docs/                          # Documentation
+├── requirements.txt               # Dependencies
+├── setup.py                       # Package setup
+├── pyproject.toml                 # Modern Python project config
+└── Makefile                       # Development commands
+```
+
+## Configuration System
+
+### Gateway Configuration (`config/sovd_gateway.yaml`)
+- Network settings (host, port)
+- Logging configuration
+- Security settings (disabled for testing)
+- Entity and resource file references
+
+### Entity Configurations
+- **Areas**: Vehicle areas (engine, transmission, brakes)
+- **Components**: Vehicle components (ECU, sensors, cameras)
+- **Apps**: Diagnostic applications
+
+### Resource Configurations
+- **Data Resources**: Actual data with schemas (e.g., SoftwarePartNumber, EngineRPM)
+- **Operations**: Operation definitions with request/response payloads (e.g., calibratecamera)
+- **Faults**: Fault definitions with severity and diagnostic information
+- **Modes**: Operation modes with capabilities and limitations
+
+## Installation
+
+1. **Set up virtual environment**:
+   ```bash
+   python3 -m venv venv
+   source venv/bin/activate
+   ```
+
+2. **Install dependencies**:
+   ```bash
+   pip install -r requirements.txt
+   ```
+
+3. **Install in development mode**:
+   ```bash
+   pip install -e .
+   ```
+
+4. **Test configuration**:
+   ```bash
+   python tests/test_config.py
+   ```
+
+## Running the Server
+
+### Enhanced Server (Recommended)
+```bash
+make run-server
+# or
+python src/sovd_server/run_enhanced_server.py
+```
+
+### Simple Server (Basic)
+```bash
+python generated/simple_server.py
+```
+
+## Development Commands
+
+```bash
+make help          # Show all available commands
+make install-dev   # Install development dependencies
+make test          # Run all tests
+make lint          # Run linting checks
+make format        # Format code with black
+make clean         # Clean up build artifacts
+```
+
+## API Endpoints
+
+### Basic Endpoints
+- `GET /health` - Health check
+- `GET /version-info` - Server version information
+
+### Collection Endpoints
+- `GET /areas` - List vehicle areas
+- `GET /components` - List vehicle components  
+- `GET /apps` - List diagnostic applications
+
+### Entity Endpoints
+- `GET /{entity-path}` - Get entity capabilities
+- `GET /{entity-path}/data` - Get data resources
+- `GET /{entity-path}/data/{data-id}` - Get specific data resource
+- `GET /{entity-path}/operations` - Get operations
+- `GET /{entity-path}/operations/{operation-id}` - Get specific operation
+- `POST /{entity-path}/operations/{operation-id}` - Start operation execution
+- `GET /{entity-path}/faults` - Get faults
+- `GET /{entity-path}/modes` - Get modes
+
+## Example Usage
+
+### Get Engine Data
+```bash
+curl http://localhost:8080/engine/data
+```
+
+### Get Software Part Number
+```bash
+curl http://localhost:8080/engine/data/SoftwarePartNumber
+```
+
+### Start Camera Calibration
+```bash
+curl -X POST http://localhost:8080/camera/front/operations/calibratecamera \
+  -H "Content-Type: application/json" \
+  -d '{"calibration_type": "automatic", "target_distance": 10.0}'
+```
+
+## Configuration Examples
+
+### Data Resource Example
+```yaml
+data_resources:
+  - id: "SoftwarePartNumber"
+    name: "Software Part Number"
+    description: "Current software part number installed on the engine ECU"
+    category: "software"
+    data:
+      value: "SW-ENG-2024.1.0-REV-A"
+      version: "2024.1.0"
+      revision: "A"
+```
+
+### Operation Example
+```yaml
+operations:
+  - id: "calibratecamera"
+    name: "Calibrate Camera"
+    description: "Calibrate the front camera system for optimal performance"
+    execution:
+      type: "asynchronous"
+      timeout: 300
+    request_payload:
+      calibration_type:
+        type: "string"
+        enum: ["automatic", "manual", "advanced"]
+        default: "automatic"
+```
+
+## Testing
+
+### Run All Tests
+```bash
+make test
+```
+
+### Configuration Test
+```bash
+python tests/test_config.py
+```
+
+### Endpoint Test
+```bash
+python tests/test_endpoints.py
+```
+
+## Development
+
+The system is designed to be easily extensible:
+
+1. **Add new entities**: Create new YAML files in `src/sovd_server/config/entities/`
+2. **Add new resources**: Create new YAML files in `src/sovd_server/config/resources/`
+3. **Modify data**: Update the YAML files with new data
+4. **Add endpoints**: Extend the enhanced server with new routes
+
+## Documentation
+
+Full documentation is in the [docs/](docs/INDEX.md) directory: configuration, contributing, testing, deployment, security, and changelog.
+
+## Notes
+
+- The server runs without authentication for testing purposes
+- All configuration is loaded from YAML files
+- The system uses the auto-generated SOVD models for proper API compliance
+- CORS is enabled for web client testing
+- Logging is configured through the gateway configuration
+
+## Troubleshooting
+
+1. **Configuration not loading**: Check file paths in YAML files
+2. **Endpoints returning 404**: Verify entity paths match configuration
+3. **Data not found**: Check resource file references in entity configs
+4. **Server not starting**: Check port availability and dependencies

sovd_server-1.0.0/README.md

@@ -0,0 +1,227 @@
+# SOVD Server with YAML Configuration
+
+This project implements a Service-Oriented Vehicle Diagnostics (SOVD) server based on ISO/DIS 17978-3:2025 with YAML-based configuration support.
+
+## Features
+
+- **Hierarchical YAML Configuration**: Multi-level configuration system with gateway, entity, and resource configurations
+- **Real Data Endpoints**: Actual data for data resources, operations, faults, and modes
+- **No Authentication**: Simplified setup without authorization layer for testing
+- **RESTful API**: Full SOVD API implementation with proper JSON responses
+- **Configurable Entities**: Support for areas, components, and applications
+- **Resource Management**: Data resources, operations, faults, modes, and configurations
+
+## Project Structure
+
+```
+sovd_server/
+├── src/
+│   └── sovd_server/               # Main source code
+│       ├── config/                # Configuration files
+│       │   ├── sovd_gateway.yaml  # Main gateway configuration
+│       │   ├── entities/          # Entity configurations
+│       │   │   ├── areas.yaml
+│       │   │   ├── components.yaml
+│       │   │   └── apps.yaml
+│       │   └── resources/         # Resource configurations
+│       │       ├── data/          # Data resource configs
+│       │       ├── operations/    # Operation configs
+│       │       ├── faults/        # Fault configs
+│       │       └── modes/         # Mode configs
+│       ├── enhanced_server.py     # Enhanced server with YAML support
+│       ├── config_loader.py       # YAML configuration loader
+│       └── run_enhanced_server.py # Server runner script
+├── tests/                         # Test files
+│   ├── test_config.py             # Configuration testing
+│   ├── test_endpoints.py          # Endpoint testing
+│   └── debug_*.py                 # Debug utilities
+├── generated/                     # Auto-generated SOVD server
+├── docs/                          # Documentation
+├── requirements.txt               # Dependencies
+├── setup.py                       # Package setup
+├── pyproject.toml                 # Modern Python project config
+└── Makefile                       # Development commands
+```
+
+## Configuration System
+
+### Gateway Configuration (`config/sovd_gateway.yaml`)
+- Network settings (host, port)
+- Logging configuration
+- Security settings (disabled for testing)
+- Entity and resource file references
+
+### Entity Configurations
+- **Areas**: Vehicle areas (engine, transmission, brakes)
+- **Components**: Vehicle components (ECU, sensors, cameras)
+- **Apps**: Diagnostic applications
+
+### Resource Configurations
+- **Data Resources**: Actual data with schemas (e.g., SoftwarePartNumber, EngineRPM)
+- **Operations**: Operation definitions with request/response payloads (e.g., calibratecamera)
+- **Faults**: Fault definitions with severity and diagnostic information
+- **Modes**: Operation modes with capabilities and limitations
+
+## Installation
+
+1. **Set up virtual environment**:
+   ```bash
+   python3 -m venv venv
+   source venv/bin/activate
+   ```
+
+2. **Install dependencies**:
+   ```bash
+   pip install -r requirements.txt
+   ```
+
+3. **Install in development mode**:
+   ```bash
+   pip install -e .
+   ```
+
+4. **Test configuration**:
+   ```bash
+   python tests/test_config.py
+   ```
+
+## Running the Server
+
+### Enhanced Server (Recommended)
+```bash
+make run-server
+# or
+python src/sovd_server/run_enhanced_server.py
+```
+
+### Simple Server (Basic)
+```bash
+python generated/simple_server.py
+```
+
+## Development Commands
+
+```bash
+make help          # Show all available commands
+make install-dev   # Install development dependencies
+make test          # Run all tests
+make lint          # Run linting checks
+make format        # Format code with black
+make clean         # Clean up build artifacts
+```
+
+## API Endpoints
+
+### Basic Endpoints
+- `GET /health` - Health check
+- `GET /version-info` - Server version information
+
+### Collection Endpoints
+- `GET /areas` - List vehicle areas
+- `GET /components` - List vehicle components  
+- `GET /apps` - List diagnostic applications
+
+### Entity Endpoints
+- `GET /{entity-path}` - Get entity capabilities
+- `GET /{entity-path}/data` - Get data resources
+- `GET /{entity-path}/data/{data-id}` - Get specific data resource
+- `GET /{entity-path}/operations` - Get operations
+- `GET /{entity-path}/operations/{operation-id}` - Get specific operation
+- `POST /{entity-path}/operations/{operation-id}` - Start operation execution
+- `GET /{entity-path}/faults` - Get faults
+- `GET /{entity-path}/modes` - Get modes
+
+## Example Usage
+
+### Get Engine Data
+```bash
+curl http://localhost:8080/engine/data
+```
+
+### Get Software Part Number
+```bash
+curl http://localhost:8080/engine/data/SoftwarePartNumber
+```
+
+### Start Camera Calibration
+```bash
+curl -X POST http://localhost:8080/camera/front/operations/calibratecamera \
+  -H "Content-Type: application/json" \
+  -d '{"calibration_type": "automatic", "target_distance": 10.0}'
+```
+
+## Configuration Examples
+
+### Data Resource Example
+```yaml
+data_resources:
+  - id: "SoftwarePartNumber"
+    name: "Software Part Number"
+    description: "Current software part number installed on the engine ECU"
+    category: "software"
+    data:
+      value: "SW-ENG-2024.1.0-REV-A"
+      version: "2024.1.0"
+      revision: "A"
+```
+
+### Operation Example
+```yaml
+operations:
+  - id: "calibratecamera"
+    name: "Calibrate Camera"
+    description: "Calibrate the front camera system for optimal performance"
+    execution:
+      type: "asynchronous"
+      timeout: 300
+    request_payload:
+      calibration_type:
+        type: "string"
+        enum: ["automatic", "manual", "advanced"]
+        default: "automatic"
+```
+
+## Testing
+
+### Run All Tests
+```bash
+make test
+```
+
+### Configuration Test
+```bash
+python tests/test_config.py
+```
+
+### Endpoint Test
+```bash
+python tests/test_endpoints.py
+```
+
+## Development
+
+The system is designed to be easily extensible:
+
+1. **Add new entities**: Create new YAML files in `src/sovd_server/config/entities/`
+2. **Add new resources**: Create new YAML files in `src/sovd_server/config/resources/`
+3. **Modify data**: Update the YAML files with new data
+4. **Add endpoints**: Extend the enhanced server with new routes
+
+## Documentation
+
+Full documentation is in the [docs/](docs/INDEX.md) directory: configuration, contributing, testing, deployment, security, and changelog.
+
+## Notes
+
+- The server runs without authentication for testing purposes
+- All configuration is loaded from YAML files
+- The system uses the auto-generated SOVD models for proper API compliance
+- CORS is enabled for web client testing
+- Logging is configured through the gateway configuration
+
+## Troubleshooting
+
+1. **Configuration not loading**: Check file paths in YAML files
+2. **Endpoints returning 404**: Verify entity paths match configuration
+3. **Data not found**: Check resource file references in entity configs
+4. **Server not starting**: Check port availability and dependencies

sovd_server-1.0.0/pyproject.toml

@@ -0,0 +1,102 @@
+[build-system]
+requires = ["setuptools>=45", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "sovd-server"
+version = "1.0.0"
+description = "SOVD (Service-Oriented Vehicle Data) Server Implementation"
+readme = "README.md"
+requires-python = ">=3.9,<4.0"
+license = {text = "MIT"}
+authors = [
+    {name = "SOVD Development Team", email = "dev@sovd.org"},
+]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+]
+dependencies = [
+    "flask>=3.1.0",
+    "flask-cors>=3.0.0",
+    "pyyaml>=6.0",
+    "connexion[swagger-ui]>=3.0.0,<=3.3.0",
+    "jsonschema>=4.0.0",
+]
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=8.4.2",
+    "pytest-cov",
+    "black",
+    "flake8",
+    "mypy",
+    "bandit",
+    "safety",
+]
+
+[project.scripts]
+sovd-server = "src.sovd_server.run_enhanced_server:main"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools.package-data]
+sovd_server = ["config/*.yaml", "config/**/*.yaml"]
+
+[tool.black]
+line-length = 88
+target-version = ['py39']
+include = '\.pyi?$'
+extend-exclude = '''
+/(
+  # directories
+  \.eggs
+  | \.git
+  | \.hg
+  | \.mypy_cache
+  | \.tox
+  | \.venv
+  | venv
+  | _build
+  | buck-out
+  | build
+  | dist
+  # generated OpenAPI code (symlinked under src/sovd_server)
+  | src/sovd_server/models
+  | src/sovd_server/controllers
+  | src/sovd_server/util\.py
+  | src/sovd_server/typing_utils\.py
+  | src/sovd_server/encoder\.py
+  | generated
+)/
+'''
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+python_files = ["test_*.py"]
+python_classes = ["Test*"]
+python_functions = ["test_*"]
+addopts = "-v --tb=short"
+
+[tool.mypy]
+python_version = "3.9"
+warn_return_any = true
+warn_unused_configs = true
+disallow_untyped_defs = true
+
+[dependency-groups]
+dev = [
+    "pytest (>=8.4.2,<9.0.0)",
+    "pytest-cov (>=7.0.0,<8.0.0)",
+    "black (>=25.9.0,<26.0.0)",
+    "flake8 (>=7.3.0,<8.0.0)",
+    "mypy (>=1.18.2,<2.0.0)"
+]

sovd_server-1.0.0/requirements.txt

@@ -0,0 +1,13 @@
+# Core dependencies
+flask>=3.1.0
+flask-cors>=3.0.0
+pyyaml>=6.0
+connexion[swagger-ui]>=3.0.0,<=3.3.0
+jsonschema>=4.0.0
+
+# Development dependencies (install with: pip install -r requirements.txt[dev])
+pytest>=8.4.2
+pytest-cov
+black
+flake8
+mypy

sovd_server-1.0.0/setup.cfg

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

sovd_server-1.0.0/setup.py

@@ -0,0 +1,81 @@
+#!/usr/bin/env python3
+"""
+Setup script for SOVD Server
+"""
+
+import os
+
+from setuptools import setup, find_packages
+
+_ROOT = os.path.dirname(os.path.abspath(__file__))
+
+with open(os.path.join(_ROOT, "README.md"), "r", encoding="utf-8") as fh:
+    long_description = fh.read()
+
+requirements_path = os.path.join(_ROOT, "requirements.txt")
+if os.path.isfile(requirements_path):
+    with open(requirements_path, "r", encoding="utf-8") as fh:
+        requirements = []
+        for line in fh:
+            line = line.strip()
+            if line.startswith("# Development"):
+                break
+            if line and not line.startswith("#"):
+                requirements.append(line)
+else:
+    # Fallback when building from sdist without requirements.txt (use pyproject.toml deps)
+    requirements = [
+        "flask>=3.1.0",
+        "flask-cors>=3.0.0",
+        "pyyaml>=6.0",
+        "connexion[swagger-ui]>=3.0.0,<=3.3.0",
+        "jsonschema>=4.0.0",
+    ]
+
+setup(
+    name="sovd-server",
+    version="1.0.0",
+    author="SOVD Development Team",
+    author_email="dev@sovd.org",
+    description="SOVD (Service-Oriented Vehicle Data) Server Implementation",
+    long_description=long_description,
+    long_description_content_type="text/markdown",
+    url="https://github.com/sovd/sovd-server",
+    packages=find_packages(where="src"),
+    package_dir={"": "src"},
+    classifiers=[
+        "Development Status :: 4 - Beta",
+        "Intended Audience :: Developers",
+        "License :: OSI Approved :: MIT License",
+        "Operating System :: OS Independent",
+        "Programming Language :: Python :: 3",
+        "Programming Language :: Python :: 3.8",
+        "Programming Language :: Python :: 3.9",
+        "Programming Language :: Python :: 3.10",
+        "Programming Language :: Python :: 3.11",
+        "Programming Language :: Python :: 3.12",
+    ],
+    python_requires=">=3.8",
+    install_requires=requirements,
+    extras_require={
+        "dev": [
+            "pytest>=6.0",
+            "pytest-cov",
+            "black",
+            "flake8",
+            "mypy",
+        ],
+    },
+    entry_points={
+        "console_scripts": [
+            "sovd-server=src.sovd_server.run_enhanced_server:main",
+        ],
+    },
+    include_package_data=True,
+    package_data={
+        "sovd_server": [
+            "config/*.yaml",
+            "config/**/*.yaml",
+        ],
+    },
+)