Data Modelling SDK

Shared SDK for model operations across platforms (API, WASM, Native).

Features

Storage Backends: File system, browser storage (IndexedDB/localStorage), and HTTP API
Model Loading/Saving: Load and save models from various storage backends
Import/Export: Import from SQL, ODCL, JSON Schema, AVRO, Protobuf; Export to various formats
Validation: Table and relationship validation (naming conflicts, circular dependencies)

Usage

File System Backend (Native Apps)

use data_modelling_sdk::storage::filesystem::FileSystemStorageBackend;
use data_modelling_sdk::model::ModelLoader;

let storage = FileSystemStorageBackend::new("/path/to/workspace");
let loader = ModelLoader::new(storage);
let result = loader.load_model("workspace_path").await?;

Browser Storage Backend (WASM Apps)

use data_modelling_sdk::storage::browser::BrowserStorageBackend;
use data_modelling_sdk::model::ModelLoader;

let storage = BrowserStorageBackend::new("db_name", "store_name");
let loader = ModelLoader::new(storage);
let result = loader.load_model("workspace_path").await?;

API Backend (Online Mode)

use data_modelling_sdk::storage::api::ApiStorageBackend;
use data_modelling_sdk::model::ModelLoader;

let storage = ApiStorageBackend::new("http://localhost:8081/api/v1", Some("session_id"));
let loader = ModelLoader::new(storage);
let result = loader.load_model("workspace_path").await?;

Development

Pre-commit Hooks

This project uses pre-commit hooks to ensure code quality. Install them with:

# Install pre-commit (if not already installed)
pip install pre-commit

# Install the git hooks
pre-commit install

# Run hooks manually on all files
pre-commit run --all-files

The hooks will automatically run on git commit and check:

Rust formatting (cargo fmt)
Rust linting (cargo clippy)
Security audit (cargo audit)
File formatting (trailing whitespace, end of file, etc.)
YAML/TOML/JSON syntax

CI/CD

GitHub Actions workflows automatically run on push and pull requests:

Lint: Format check, clippy, and security audit
Test: Unit and integration tests on Linux, macOS, and Windows
Build: Release build verification
Publish: Automatic publishing to crates.io on main branch (after all checks pass)

Status

The SDK structure is in place. The actual implementation of import/export/validation logic is being migrated incrementally from the parent crate. Currently, the SDK provides:

✅ Storage backend abstraction and implementations
✅ Model loader/saver structure
✅ Import/export module structure
✅ Validation module structure
⏳ Full implementation of parsers/exporters (in progress)

data-modelling-sdk 1.0.2