dataproduct-cli 0.0.1__py3-none-any.whl

dataproduct/schemas/odps-1.0.0.schema.json

@@ -0,0 +1,517 @@
+{
+  "$schema": "https://json-schema.org/draft/2019-09/schema",
+  "title": "Open Data Product Standard (ODPS)",
+  "description": "An open data product standard descriptor to enable defining data products.",
+  "type": "object",
+  "required": ["apiVersion", "kind", "id", "status"],
+  "additionalProperties": false,
+  "properties": {
+    "apiVersion": {
+      "type": "string",
+      "default": "v1.0.0",
+      "description": "Version of the standard used to build data product. Default value is v1.0.0.",
+      "enum": ["v0.9.0", "v1.0.0"]
+    },
+    "kind": {
+      "type": "string",
+      "default": "DataProduct",
+      "description": "The kind of file this is. Valid value is `DataProduct`.",
+      "enum": ["DataProduct"]
+    },
+    "id": {
+      "type": "string",
+      "description": "A unique identifier used to reduce the risk of dataset name collisions, such as a UUID."
+    },
+    "name": {
+      "type": "string",
+      "description": "Name of the data product."
+    },
+    "version": {
+      "type": "string",
+      "description": "Current version of the data product. Not required, but highly recommended."
+    },
+    "status": {
+      "type": "string",
+      "description": "Current status of the data product.",
+      "examples": ["proposed", "draft", "active", "deprecated", "retired"]
+    },
+    "domain": {
+      "type": "string",
+      "description": "Business domain"
+    },
+    "tenant": {
+      "type": "string",
+      "description": "Organization identifier"
+    },
+    "authoritativeDefinitions": {
+      "type": "array",
+      "description": "List of links to sources that provide more details on the data contract.",
+      "items": {
+        "$ref": "#/$defs/AuthoritativeDefinition"
+      }
+    },
+    "description": {
+      "$ref": "#/$defs/Description"
+    },
+    "customProperties": {
+      "type": "array",
+      "description": "A list of key/value pairs for custom properties.",
+      "items": {
+        "$ref": "#/$defs/CustomProperty"
+      }
+    },
+    "tags": {
+      "$ref": "#/$defs/Tags"
+    },
+    "inputPorts": {
+      "type": "array",
+      "description": "List of objects describing an input port. You need at least one as a data product needs to get data somewhere.",
+      "items": {
+        "$ref": "#/$defs/InputPort"
+      }
+    },
+    "outputPorts": {
+      "type": "array",
+      "description": "List of objects describing an output port. You need at least one, as a data product without output is useless.",
+      "items": {
+        "$ref": "#/$defs/OutputPort"
+      }
+    },
+    "managementPorts": {
+      "type": "array",
+      "description": "Management ports define access points for managing the data product.",
+      "items": {
+        "$ref": "#/$defs/ManagementPort"
+      }
+    },
+    "support": {
+      "type": "array",
+      "description": "Support and communication channels.",
+      "items": {
+        "$ref": "#/$defs/Support"
+      }
+    },
+    "team": {
+      "$ref": "#/$defs/Team"
+    },
+    "productCreatedTs": {
+      "type": "string",
+      "format": "date-time",
+      "description": "Timestamp in UTC of when the data product was created, using ISO 8601."
+    }
+  },
+  "$defs": {
+    "Tags": {
+      "type": "array",
+      "description": "A list of tags that may be assigned to the elements (object or property); the tags keyword may appear at any level. Tags may be used to better categorize an element. For example, `finance`, `sensitive`, `employee_record`.",
+      "examples": ["finance", "sensitive", "employee_record"],
+      "items": {
+        "type": "string"
+      }
+    },
+    "Description": {
+      "type": "object",
+      "description": "Object containing the descriptions.",
+      "additionalProperties": false,
+      "properties": {
+        "purpose": {
+          "type": "string",
+          "description": "Intended purpose for the provided data."
+        },
+        "limitations": {
+          "type": "string",
+          "description": "Technical, compliance, and legal limitations for data use."
+        },
+        "usage": {
+          "type": "string",
+          "description": "Recommended usage of the data."
+        },
+        "authoritativeDefinitions": {
+          "type": "array",
+          "description": "List of links to sources that provide more details on the data contract.",
+          "items": {
+            "$ref": "#/$defs/AuthoritativeDefinition"
+          }
+        },
+        "customProperties": {
+          "type": "array",
+          "description": "A list of key/value pairs for custom properties.",
+          "items": {
+            "$ref": "#/$defs/CustomProperty"
+          }
+        }
+      }
+    },
+    "CustomProperty": {
+      "type": "object",
+      "description": "A key/value pair for custom properties.",
+      "additionalProperties": false,
+      "properties": {
+        "property": {
+          "type": "string",
+          "description": "The name of the key. Names should be in camel case, the same as if they were permanent properties in the contract."
+        },
+        "value": {
+          "description": "The value of the key."
+        },
+        "description": {
+          "type": "string",
+          "description": "Optional description."
+        }
+      },
+      "required": ["property", "value"]
+    },
+    "AuthoritativeDefinition": {
+      "type": "object",
+      "description": "A type/link pair for authoritative definitions.",
+      "additionalProperties": false,
+      "properties": {
+        "type": {
+          "type": "string",
+          "description": "Type of definition for authority.",
+          "examples": ["businessDefinition", "transformationImplementation", "videoTutorial", "tutorial", "implementation"]
+        },
+        "url": {
+          "type": "string",
+          "format": "uri",
+          "description": "URL to the authority."
+        },
+        "description": {
+          "type": "string",
+          "description": "Optional description."
+        }
+      },
+      "required": ["type", "url"]
+    },
+    "InputPort": {
+      "type": "object",
+      "description": "An input port describing expectations.",
+      "additionalProperties": false,
+      "properties": {
+        "name": {
+          "type": "string",
+          "description": "Name of the input port."
+        },
+        "version": {
+          "type": "string",
+          "description": "Version of the input port."
+        },
+        "contractId": {
+          "type": "string",
+          "description": "Contract ID for the input port."
+        },
+        "tags": {
+          "$ref": "#/$defs/Tags"
+        },
+        "customProperties": {
+          "type": "array",
+          "description": "Custom properties block.",
+          "items": {
+            "$ref": "#/$defs/CustomProperty"
+          }
+        },
+        "authoritativeDefinitions": {
+          "type": "array",
+          "description": "Authoritative definitions block.",
+          "items": {
+            "$ref": "#/$defs/AuthoritativeDefinition"
+          }
+        }
+      },
+      "required": ["name", "version", "contractId"]
+    },
+    "OutputPort": {
+      "type": "object",
+      "description": "An output port describing promises.",
+      "additionalProperties": false,
+      "properties": {
+        "name": {
+          "type": "string",
+          "description": "Name of the output port."
+        },
+        "description": {
+          "type": "string",
+          "description": "Human readable short description of the output port."
+        },
+        "type": {
+          "type": "string",
+          "description": "There can be different types of output ports, each automated and handled differently. Here you can indicate the type."
+        },
+        "version": {
+          "type": "string",
+          "description": "For each version, a different instance of the output port is listed. The combination of the name and version is the key."
+        },
+        "contractId": {
+          "type": "string",
+          "description": "Contract ID for the output port."
+        },
+        "sbom": {
+          "type": "array",
+          "description": "The SBOM can/should be at the version level.",
+          "items": {
+            "$ref": "#/$defs/SBOM"
+          }
+        },
+        "inputContracts": {
+          "type": "array",
+          "description": "Dependencies or input contracts.",
+          "items": {
+            "$ref": "#/$defs/InputContract"
+          }
+        },
+        "tags": {
+          "$ref": "#/$defs/Tags"
+        },
+        "customProperties": {
+          "type": "array",
+          "description": "Custom properties block.",
+          "items": {
+            "$ref": "#/$defs/CustomProperty"
+          }
+        },
+        "authoritativeDefinitions": {
+          "type": "array",
+          "description": "Authoritative definitions block.",
+          "items": {
+            "$ref": "#/$defs/AuthoritativeDefinition"
+          }
+        }
+      },
+      "required": ["name", "version"]
+    },
+    "SBOM": {
+      "type": "object",
+      "description": "Software Bill of Materials.",
+      "additionalProperties": false,
+      "properties": {
+        "type": {
+          "type": "string",
+          "default": "external",
+          "description": "Type of SBOM."
+        },
+        "url": {
+          "type": "string",
+          "format": "uri",
+          "description": "URL to the SBOM."
+        }
+      },
+      "required": ["url"]
+    },
+    "InputContract": {
+      "type": "object",
+      "description": "Input contract dependency.",
+      "additionalProperties": false,
+      "properties": {
+        "id": {
+          "type": "string",
+          "description": "Contract ID or contractId."
+        },
+        "version": {
+          "type": "string",
+          "description": "Version of the input contract."
+        }
+      },
+      "required": ["id", "version"]
+    },
+    "ManagementPort": {
+      "type": "object",
+      "description": "Management port for managing the data product.",
+      "additionalProperties": false,
+      "properties": {
+        "name": {
+          "type": "string",
+          "description": "Endpoint identifier or unique name."
+        },
+        "content": {
+          "type": "string",
+          "description": "Content type.",
+          "examples": ["discoverability", "observability", "control", "dictionary"]
+        },
+        "type": {
+          "type": "string",
+          "default": "rest",
+          "description": "Type: can be `rest` or `topic`. Default is `rest`.",
+          "examples": ["rest", "topic"]
+        },
+        "url": {
+          "type": "string",
+          "format": "uri",
+          "description": "URL to access the endpoint."
+        },
+        "channel": {
+          "type": "string",
+          "description": "Channel to communicate with the data product."
+        },
+        "description": {
+          "type": "string",
+          "description": "Purpose and usage."
+        },
+        "tags": {
+          "$ref": "#/$defs/Tags"
+        },
+        "customProperties": {
+          "type": "array",
+          "description": "Custom properties block.",
+          "items": {
+            "$ref": "#/$defs/CustomProperty"
+          }
+        },
+        "authoritativeDefinitions": {
+          "type": "array",
+          "description": "Authoritative definitions block.",
+          "items": {
+            "$ref": "#/$defs/AuthoritativeDefinition"
+          }
+        }
+      },
+      "required": ["name", "content"]
+    },
+    "Support": {
+      "type": "object",
+      "description": "Support channel.",
+      "additionalProperties": false,
+      "properties": {
+        "channel": {
+          "type": "string",
+          "description": "Channel name or identifier."
+        },
+        "url": {
+          "type": "string",
+          "format": "uri",
+          "description": "Access URL using normal URL scheme (https, mailto, etc.)."
+        },
+        "description": {
+          "type": "string",
+          "description": "Description of the channel, free text."
+        },
+        "tool": {
+          "type": "string",
+          "description": "Name of the tool.",
+          "examples": ["email", "slack", "teams", "discord", "ticket", "other"]
+        },
+        "scope": {
+          "type": "string",
+          "description": "Scope can be: `interactive`, `announcements`, `issues`.",
+          "examples": ["interactive", "announcements", "issues"]
+        },
+        "invitationUrl": {
+          "type": "string",
+          "format": "uri",
+          "description": "Some tools uses invitation URL for requesting or subscribing. Follows the URL scheme."
+        },
+        "tags": {
+          "$ref": "#/$defs/Tags"
+        },
+        "customProperties": {
+          "type": "array",
+          "description": "Custom properties block.",
+          "items": {
+            "$ref": "#/$defs/CustomProperty"
+          }
+        },
+        "authoritativeDefinitions": {
+          "type": "array",
+          "description": "Authoritative definitions block.",
+          "items": {
+            "$ref": "#/$defs/AuthoritativeDefinition"
+          }
+        }
+      },
+      "required": ["channel", "url"]
+    },
+    "TeamMember": {
+      "type": "object",
+      "description": "Team member information.",
+      "additionalProperties": false,
+      "properties": {
+        "username": {
+          "type": "string",
+          "description": "The user's username or email."
+        },
+        "name": {
+          "type": "string",
+          "description": "The user's name."
+        },
+        "description": {
+          "type": "string",
+          "description": "The user's description."
+        },
+        "role": {
+          "type": "string",
+          "description": "The user's job role; Examples might be owner, data steward. There is no limit on the role."
+        },
+        "dateIn": {
+          "type": "string",
+          "format": "date",
+          "description": "The date when the user joined the team."
+        },
+        "dateOut": {
+          "type": "string",
+          "format": "date",
+          "description": "The date when the user ceased to be part of the team."
+        },
+        "replacedByUsername": {
+          "type": "string",
+          "description": "The username of the user who replaced the previous user."
+        },
+        "tags": {
+          "$ref": "#/$defs/Tags"
+        },
+        "customProperties": {
+          "type": "array",
+          "description": "Custom properties block.",
+          "items": {
+            "$ref": "#/$defs/CustomProperty"
+          }
+        },
+        "authoritativeDefinitions": {
+          "type": "array",
+          "description": "Authoritative definitions block.",
+          "items": {
+            "$ref": "#/$defs/AuthoritativeDefinition"
+          }
+        }
+      },
+      "required": ["username"]
+    },
+    "Team": {
+      "type": "object",
+      "description": "Team information.",
+      "additionalProperties": false,
+      "properties": {
+        "name": {
+          "type": "string",
+          "description": "Team name."
+        },
+        "description": {
+          "type": "string",
+          "description": "Team description."
+        },
+        "members": {
+          "type": "array",
+          "description": "List of members.",
+          "items": {
+            "$ref": "#/$defs/TeamMember"
+          }
+        },
+        "tags": {
+          "$ref": "#/$defs/Tags"
+        },
+        "customProperties": {
+          "type": "array",
+          "description": "Custom properties block.",
+          "items": {
+            "$ref": "#/$defs/CustomProperty"
+          }
+        },
+        "authoritativeDefinitions": {
+          "type": "array",
+          "description": "Authoritative definitions block.",
+          "items": {
+            "$ref": "#/$defs/AuthoritativeDefinition"
+          }
+        }
+      }
+    }
+  }
+}

dataproduct_cli-0.0.1.dist-info/METADATA

@@ -0,0 +1,126 @@
+Metadata-Version: 2.4
+Name: dataproduct-cli
+Version: 0.0.1
+Summary: The dataproduct CLI is an open source command-line tool for working with data products. It uses data product YAML files following the Open Data Product Standard (ODPS) to lint the definition against the standard and publish it to Entropy Data. The tool is written in Python. It can be used as a standalone CLI tool, in a CI/CD pipeline, or directly as a Python library.
+Author-email: Michael Kutz <michael.kutz@entropy-data.com>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/datacontract/dataproduct-cli
+Project-URL: Repository, https://github.com/datacontract/dataproduct-cli
+Project-URL: Issues, https://github.com/datacontract/dataproduct-cli/issues
+Keywords: data-product,data-products,odps,open-data-product-standard,data-governance,data-mesh,data-engineering
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Information Technology
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+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 :: Database
+Classifier: Topic :: Software Development :: Quality Assurance
+Requires-Python: <3.15,>=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: typer<0.28,>=0.18.0
+Requires-Dist: click<9.0.0,>=8.1.0
+Requires-Dist: pydantic<2.14.0,>=2.8.2
+Requires-Dist: pyyaml~=6.0.1
+Requires-Dist: requests<2.35,>=2.31
+Requires-Dist: jsonschema<5.0.0,>=4.23.0
+Requires-Dist: rich<16.0,>=13.7
+Requires-Dist: python-dotenv<2.0.0,>=1.0.0
+Requires-Dist: typing-extensions>=4.7.0
+Provides-Extra: dev
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pytest-xdist; extra == "dev"
+Requires-Dist: ruff==0.16.1; extra == "dev"
+Requires-Dist: pre-commit<4.7.0,>=3.7.1; extra == "dev"
+Dynamic: license-file
+
+# Data Product CLI
+
+The `dataproduct` CLI is an open-source command-line tool for working with
+**data products** defined with the
+[Open Data Product Standard (ODPS)](https://bitol-io.github.io/open-data-product-standard/v1.0.0/).
+
+It is the data-product sibling of
+[`datacontract-cli`](https://github.com/datacontract/datacontract-cli) (which
+targets the Open Data **Contract** Standard) and mirrors its technology and
+release mechanism. The tool is written in Python and can be used standalone, in
+CI/CD, or as a Python library.
+
+> The behavior of each command is specified in [`specs/`](specs/).
+
+## Install
+
+```bash
+uv tool install --python python3.11 dataproduct-cli
+# or
+pip install dataproduct-cli
+```
+
+## Commands
+
+### `init` — create a data product
+
+```bash
+dataproduct init                       # writes ./dataproduct.odps.yaml
+dataproduct init my.odps.yaml          # custom path
+dataproduct init --overwrite           # replace an existing file
+dataproduct init --template <url|path> # seed from a template or existing product
+```
+
+### `lint` — validate against the ODPS standard
+
+```bash
+dataproduct lint                                   # lints ./dataproduct.odps.yaml
+dataproduct lint my.odps.yaml
+dataproduct lint --all-errors                      # report every schema violation
+dataproduct lint --output-format junit --output TEST-dataproduct.xml
+dataproduct lint --json-schema ./odps.schema.json  # validate against a custom schema
+```
+
+Validation is schema-only in 0.1: the data product is checked against the
+bundled ODPS v1.0.0 JSON Schema. Exit code is `0` when valid, `1` otherwise.
+
+### `publish` — publish to Entropy Data
+
+```bash
+export ENTROPY_DATA_API_KEY=...        # from Entropy Data → Settings → API Keys
+dataproduct publish my.odps.yaml
+```
+
+`publish` sends `PUT {host}/api/dataproducts/{id}` with an `x-api-key` header.
+The host defaults to `https://api.entropy-data.com` and can be overridden with
+`ENTROPY_DATA_HOST`. The referenced `team` must already exist in your org.
+
+## Configuration
+
+| Purpose | Variable (with fallbacks) |
+|---|---|
+| API host | `ENTROPY_DATA_HOST` → `DATAMESH_MANAGER_HOST` → `DATACONTRACT_MANAGER_HOST` → `https://api.entropy-data.com` |
+| API key | `ENTROPY_DATA_API_KEY` → `DATAMESH_MANAGER_API_KEY` → `DATACONTRACT_MANAGER_API_KEY` |
+
+`.env` files are loaded automatically.
+
+## Use as a library
+
+```python
+from dataproduct.data_product import DataProduct
+
+run = DataProduct(data_product_file="dataproduct.odps.yaml").lint()
+assert run.result == "passed"
+
+DataProduct(data_product_file="dataproduct.odps.yaml").publish()
+```
+
+## Development
+
+See [AGENTS.md](AGENTS.md).
+
+## License
+
+MIT

dataproduct_cli-0.0.1.dist-info/RECORD

@@ -0,0 +1,31 @@
+dataproduct/__init__.py,sha256=0f1WpVI48SdLnWWFm0AZ126Mio90p1aX5QucHI-7Pfc,192
+dataproduct/cli.py,sha256=I4ojBWQeHV_pZZeDBRqTF2wFL_IpJPUr-MAGS3bp2A4,2414
+dataproduct/command_init.py,sha256=PhHvNEt4Ylc2uFVNS4PYDV76FU6qNxTGa0tvxdxWLS4,1108
+dataproduct/command_lint.py,sha256=rWbx2ae-41DefKqlcAvzvjzJyYsCSI4l9myWVJfvL7I,1884
+dataproduct/command_publish.py,sha256=HbMrZ8sCyV7rU4WSj8YqHTZPv3dIREpwvLV_8Mp8plw,1577
+dataproduct/data_product.py,sha256=6IPzkLf4u8au87ThksqXY7SsTZsRyQbPKog4-2-XcEw,3544
+dataproduct/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+dataproduct/config/__init__.py,sha256=PKpFxQaHNpCJB11PSHdBvrGWEMal0WdynLiPQO0u358,2047
+dataproduct/init/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+dataproduct/init/init_template.py,sha256=ff7aLFFi9G3VoWx69FbTA5NyvFi1kQWIkBKbejCu6IM,913
+dataproduct/integration/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+dataproduct/integration/entropy_data.py,sha256=sExYYYXgWE9DIHmquAlDOuxJ-H8Wa9o8NmP2V6rQxeo,2871
+dataproduct/lint/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+dataproduct/lint/files.py,sha256=DTqwvnwEk6-KHF8yp6FfoItMczF93FPDdY8eGUb4rkQ,1353
+dataproduct/lint/resolve.py,sha256=O0g7bcG-XWN3SdlmvJRnsvWVAoFkrksjS1-QzuH04go,418
+dataproduct/lint/schema.py,sha256=JYJtUiIzihIJ4w9mu4qwg3zRbovMdSn6FYqMIJfqca0,1541
+dataproduct/lint/validate.py,sha256=2eAgJewBQw7bYWuENAK_T92mbix_7wqrrhHrZsQrOcA,2027
+dataproduct/model/__init__.py,sha256=r5FRAjMqeeXcuGEmS8ABf5-3eRzY6_sh33gDmtftl68,185
+dataproduct/model/exceptions.py,sha256=AuQY7q5qdsMU--wyZremnShl4jYpRpAGdwOIxzyEQws,595
+dataproduct/model/run.py,sha256=6jJHDG1XbiXjVyuNPxFyZhecC7dZOha-2JtY92DwHvI,2049
+dataproduct/output/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+dataproduct/output/output_format.py,sha256=zKNXIi_HEPOr915_hNSE69P8Ytr8-3ZbheyVLS6gcIc,93
+dataproduct/output/result_writer.py,sha256=2zj6rhXZ1446y8NyJYv1u6RQ3c4I-mNzhNq6d_h-tKM,2509
+dataproduct/schemas/odps-1.0.0.init.yaml,sha256=HcuCc8t_-gtUS1zxUbn8aL91CaMyKcarqtZu-yogxDU,812
+dataproduct/schemas/odps-1.0.0.schema.json,sha256=FyTHobuoy_Xalx8rFqNUpdqnm4iLTvSu7v2NPNem008,15782
+dataproduct_cli-0.0.1.dist-info/licenses/LICENSE,sha256=vFIVGn2cFJ7I9qKOdeHR4abFVTcmm_-cXKXqLw20GiA,1070
+dataproduct_cli-0.0.1.dist-info/METADATA,sha256=PqiviDUGSTK12MXYqqwSVpgvI1yUA5R-JtkTNM6aVDU,4795
+dataproduct_cli-0.0.1.dist-info/WHEEL,sha256=YVMoNqKzERt-wjUZwJ33xBGAwnFl-4cqbYkTtWa4itE,91
+dataproduct_cli-0.0.1.dist-info/entry_points.txt,sha256=rYeGFlPpbXI_iTRtPTBwXtTyVGcsBVMGRi39Kfe2jFs,53
+dataproduct_cli-0.0.1.dist-info/top_level.txt,sha256=j6VMVQkfs8ScWyQ76LokrdQuqn4rU2BT0ztmMyD3B60,12
+dataproduct_cli-0.0.1.dist-info/RECORD,,

dataproduct_cli-0.0.1.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (84.0.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

dataproduct_cli-0.0.1.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+dataproduct = dataproduct.cli:main