first commit

Author: simonharrer

.editorconfig

@@ -0,0 +1,15 @@
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+indent_size = 2
+indent_style = space
+insert_final_newline = false
+max_line_length = 100
+tab_width = 2
+
+[{*.py,*.pyw}]
+indent_size = 4
+max_line_length = 120
+tab_width = 4

.github/dependabot.yml

@@ -0,0 +1,11 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2 
+updates:
+  - package-ecosystem: "pip" # See documentation for possible values
+    directory: "/" # Location of package manifests
+    schedule:
+      interval: "weekly"

.github/workflows/ci.yaml

@@ -0,0 +1,35 @@
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+  workflow_call:
+
+permissions:
+  contents: read
+
+name: CI
+jobs:
+  test:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os:
+          - 'ubuntu-latest'
+        python-version:
+          - '3.10'
+          - '3.11'
+          - '3.12'
+      fail-fast: false
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install the project
+        run: uv sync --all-extras --dev
+      - name: Check formatting
+        run: uv run ruff check
+      - name: Run tests
+        run: uv run pytest

.gitignore

@@ -0,0 +1,4 @@
+.idea/
+.venv/
+__pycache__/
+uv.lock

LICENSE

@@ -0,0 +1,48 @@
+MIT License
+
+Copyright (c) 2023 innoQ Deutschland GmbH
+
+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.
+
+
+Open Source Licenses for Dependencies
+
+This project utilizes the following open-source libraries, each of which has its own respective license:
+
+1. github.com/pkg/browser v0.0.0-20210911075715-681adbf594b8
+   License: MIT License
+   License URL: https://github.com/pkg/browser/blob/main/LICENSE
+
+2. github.com/qri-io/jsonschema v0.2.1
+   License: MIT License
+   License URL: https://github.com/qri-io/jsonschema/blob/main/LICENSE
+
+3. github.com/urfave/cli/v2 v2.25.7
+   License: MIT License
+   License URL: https://github.com/urfave/cli/blob/v2.25.7/LICENSE
+
+4. gopkg.in/yaml.v3 v3.0.1
+   License: Apache License 2.0
+   License URL: https://gopkg.in/yaml.v3/blob/v3.0.1/LICENSE
+
+Please review and comply with the terms and conditions of each respective license when using this software.
+
+The complete text of each license can be found in the provided License URLs. Ensure that you adhere to the terms and obligations outlined in these licenses when using the dependencies in your project.
+
+It is your responsibility to understand and comply with the licensing terms of these dependencies as specified by the respective licenses.

MANIFEST.in

@@ -0,0 +1 @@
+include datacontract_specification/schema.json

README.md

@@ -0,0 +1,55 @@
+# Open Data Contract Standard (Python)
+
+The pip module `open-data-contract-standard` to read and write YAML files using the [Open Data Contract Standard](https://datacontract.com). The pip module was extracted from the [Data Contract CLI](https://github.com/datacontract/datacontract-cli), which is its primary user.
+
+The version number of the pip module corresponds to the version of the Open Data Contract Standard it supports.
+
+## Version Mapping
+
+| Open Data Contract Standard Version | Pip Module Version |
+|-------------------------------------|--------------------|
+| 3.0.1                               | 3.0.1              |
+
+Fixes of a specific version are shipped with post released: `3.0.1.post1`, `3.0.1.post2`, etc.
+
+## Installation
+
+```bash
+pip install open-data-contract-standard
+```
+
+## Usage
+
+```python
+from open_data_contract_standard.model import OpenDataContractStandard
+
+# Load a data contract specification from a file
+data_contract = OpenDataContractStandard.from_file('path/to/your/data_contract.yaml')
+# Print the data contract specification as a YAML string
+print(data_contract.to_yaml())
+```
+
+```python
+from open_data_contract_standard.model import OpenDataContractStandard
+
+# Load a data contract specification from a string
+data_contract_str = """
+dataContractSpecification: 1.1.0
+id: urn:datacontract:checkout:orders-latest
+info:
+  title: Orders Latest
+  version: 2.0.0
+  description: |
+    Successful customer orders in the webshop.
+    All orders since 2020-01-01.
+    Orders with their line items are in their current state (no history included).
+  owner: Checkout Team
+  status: active
+  contact:
+    name: John Doe (Data Product Owner)
+    url: https://teams.microsoft.com/l/channel/example/checkout
+"""
+data_contract = OpenDataContractStandard.from_string(data_contract_str)
+# Print the data contract specification as a YAML string
+print(data_contract.to_yaml())
+```

modelgen

@@ -0,0 +1,7 @@
+#!/bin/bash
+
+set -ex
+
+uv run datamodel-codegen --input src/open_data_contract_standard/schema.json --output src/open_data_contract_standard/model_gen.py --output-model-type pydantic_v2.BaseModel --input-file-type jsonschema --use-union-operator  --use-standard-collections --collapse-root-models
+
+uv run datamodel-codegen --input src/datacontract_specification/schema.json --output src/datacontract_specification/model_gen.py --output-model-type pydantic_v2.BaseModel --input-file-type jsonschema --use-union-operator  --use-standard-collections --collapse-root-models

pyproject.toml

@@ -0,0 +1,42 @@
+[project]
+name = "open-data-contract-standard"
+version = "3.0.1" # in sync with spec
+description = "The Pydantic Model of the Open Data Contract Standard"
+readme = "README.md"
+authors = [
+    { name = "Jochen Christ", email = "jochen.christ@innoq.com" },
+    { name = "Stefan Negele", email = "stefan.negele@innoq.com" },
+    { name = "Simon Harrer", email = "simon.harrer@innoq.com" },
+]
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+]
+requires-python = ">=3.10"
+dependencies = [
+    "pydantic>=2.8.2,<2.11.0",
+    "pyyaml~=6.0.1",
+]
+
+[project.optional-dependencies]
+dev = [
+  "pytest",
+  "ruff",
+]
+
+[project.urls]
+Homepage = "https://github.com/datacontract/open-data-contract-standard-python"
+Issues = "https://github.com/datacontract/open-data-contract-standard-python/issues"
+
+[tool.ruff]
+line-length = 120
+
+[tool.ruff.lint]
+extend-select = [
+  "I",   # re-order imports in alphabetic order
+]
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"