datacontract-cli 0.10.19__py3-none-any.whl → 0.10.20__py3-none-any.whl

datacontract/cli.py

@@ -4,7 +4,6 @@ from pathlib import Path
 from typing import Iterable, List, Optional
 
 import typer
-import uvicorn
 from click import Context
 from rich import box
 from rich.console import Console
@@ -12,7 +11,6 @@ from rich.table import Table
 from typer.core import TyperGroup
 from typing_extensions import Annotated
 
-from datacontract import web
 from datacontract.catalog.catalog import create_data_contract_html, create_index_html
 from datacontract.data_contract import DataContract, ExportFormat
 from datacontract.imports.importer import ImportFormat
@@ -442,8 +440,9 @@ def serve(
     """
     Start the datacontract web server.
     """
+    import uvicorn
 
-    uvicorn.run(web.app, port=port, host=host)
+    uvicorn.run("datacontract.web:app", port=port, host=host, reload=True)
 
 
 def _handle_result(run):

datacontract/lint/urls.py

@@ -27,8 +27,11 @@ def fetch_resource(url: str):
 
 def _set_api_key(headers, url):
     hostname = urlparse(url).hostname
+
+    datamesh_manager_api_key = os.getenv("DATAMESH_MANAGER_API_KEY")
+    datacontract_manager_api_key = os.getenv("DATACONTRACT_MANAGER_API_KEY")
+
     if hostname == "datamesh-manager.com" or hostname.endswith(".datamesh-manager.com"):
-        datamesh_manager_api_key = os.getenv("DATAMESH_MANAGER_API_KEY")
         if datamesh_manager_api_key is None or datamesh_manager_api_key == "":
             print("Error: Data Mesh Manager API Key is not set. Set env variable DATAMESH_MANAGER_API_KEY.")
             raise DataContractException(
@@ -40,7 +43,6 @@ def _set_api_key(headers, url):
             )
         headers["x-api-key"] = datamesh_manager_api_key
     elif hostname == "datacontract-manager.com" or hostname.endswith(".datacontract-manager.com"):
-        datacontract_manager_api_key = os.getenv("DATACONTRACT_MANAGER_API_KEY")
         if datacontract_manager_api_key is None or datacontract_manager_api_key == "":
             print("Error: Data Contract Manager API Key is not set. Set env variable DATACONTRACT_MANAGER_API_KEY.")
             raise DataContractException(
@@ -51,6 +53,8 @@ def _set_api_key(headers, url):
                 result="error",
             )
         headers["x-api-key"] = datacontract_manager_api_key
-    else:
-        # do nothing
-        pass
+
+    if datamesh_manager_api_key is not None and datamesh_manager_api_key != "":
+        headers["x-api-key"] = datamesh_manager_api_key
+    if datacontract_manager_api_key is not None and datacontract_manager_api_key != "":
+        headers["x-api-key"] = datacontract_manager_api_key

datacontract/web.py

@@ -1,48 +1,183 @@
-from typing import Annotated, Optional, Union
+from typing import Annotated, Optional
 
 import typer
-from fastapi import FastAPI, File
-from fastapi.responses import HTMLResponse, PlainTextResponse
+from fastapi import Body, FastAPI, Query
+from fastapi.responses import PlainTextResponse
 
 from datacontract.data_contract import DataContract, ExportFormat
+from datacontract.model.run import Run
 
-app = FastAPI()
+DATA_CONTRACT_EXAMPLE_PAYLOAD = """dataContractSpecification: 1.1.0
+id: urn:datacontract:checkout:orders-latest
+info:
+  title: Orders Latest
+  version: 2.0.0
+  owner: Sales Team
+servers:
+  production:
+    type: s3
+    location: s3://datacontract-example-orders-latest/v2/{model}/*.json
+    format: json
+    delimiter: new_line
+models:
+  orders:
+    description: One record per order. Includes cancelled and deleted orders.
+    type: table
+    fields:
+      order_id:
+        type: string
+        primaryKey: true
+      order_timestamp:
+        description: The business timestamp in UTC when the order was successfully registered in the source system and the payment was successful.
+        type: timestamp
+        required: true
+        examples:
+          - "2024-09-09T08:30:00Z"
+      order_total:
+        description: Total amount the smallest monetary unit (e.g., cents).
+        type: long
+        required: true
+        examples:
+          - 9999
+        quality:
+          - type: sql
+            description: 95% of all order total values are expected to be between 10 and 499 EUR.
+            query: |
+              SELECT quantile_cont(order_total, 0.95) AS percentile_95
+              FROM orders
+            mustBeBetween: [1000, 99900]
+      customer_id:
+        description: Unique identifier for the customer.
+        type: text
+        minLength: 10
+        maxLength: 20
+"""
 
+app = FastAPI(
+    docs_url="/",
+    title="Data Contract API",
+    summary="API to execute Data Contract CLI operations.",
+    license_info={
+        "name": "MIT License",
+        "identifier": "MIT",
+    },
+    contact={"name": "Data Contract CLI", "url": "https://cli.datacontract.com/"},
+    openapi_tags=[
+        {
+            "name": "test",
+            "externalDocs": {
+                "description": "Documentation",
+                "url": "https://cli.datacontract.com/#test",
+            },
+        },
+        {
+            "name": "lint",
+            "externalDocs": {
+                "description": "Documentation",
+                "url": "https://cli.datacontract.com/#lint",
+            },
+        },
+        {
+            "name": "export",
+            "externalDocs": {
+                "description": "Documentation",
+                "url": "https://cli.datacontract.com/#export",
+            },
+        },
+    ],
+)
 
-@app.get("/", response_class=HTMLResponse)
-def index():
-    # TODO OpenAPI spec
-    return """
-    <html>
-    <body>
-    <h1>datacontract web server</h1>
-    <ul>
-    <li>POST /lint</li>
-    <li>POST /export</li>
-    </ul>
-    </body>
-    </html>
-    """
 
+@app.post(
+    "/test",
+    tags=["test"],
+    summary="Run data contract tests",
+    description="""
+              Run schema and quality tests. Data Contract CLI connects to the data sources configured in the server section.
+              This usually requires credentials to access the data sources.
+              Credentials must be provided via environment variables when running the web server.
+              POST the data contract YAML as payload.
+            """,
+    response_model_exclude_none=True,
+    response_model_exclude_unset=True,
+)
+async def test(
+    body: Annotated[
+        str,
+        Body(
+            title="Data Contract YAML",
+            media_type="application/yaml",
+            examples=[DATA_CONTRACT_EXAMPLE_PAYLOAD],
+        ),
+    ],
+    server: Annotated[
+        str | None,
+        Query(
+            example="production",
+            description="The server name to test. Optional, if there is only one server.",
+        ),
+    ] = None,
+) -> Run:
+    return DataContract(data_contract_str=body, server=server).test()
 
-@app.post("/lint")
-def lint(file: Annotated[bytes, File()], linters: Union[str, set[str]] = "all"):
-    data_contract = DataContract(data_contract_str=str(file, encoding="utf-8"))
-    lint_result = data_contract.lint(enabled_linters=linters)
+
+@app.post(
+    "/lint",
+    tags=["lint"],
+    summary="Validate that the datacontract.yaml is correctly formatted.",
+    description="""Validate that the datacontract.yaml is correctly formatted.""",
+)
+async def lint(
+    body: Annotated[
+        str,
+        Body(
+            title="Data Contract YAML",
+            media_type="application/yaml",
+            examples=[DATA_CONTRACT_EXAMPLE_PAYLOAD],
+        ),
+    ],
+    schema: Annotated[
+        str | None,
+        Query(
+            example="https://datacontract.com/datacontract.schema.json",
+            description="The schema to use for validation. This must be a URL.",
+        ),
+    ] = None,
+):
+    data_contract = DataContract(data_contract_str=body, schema_location=schema)
+    lint_result = data_contract.lint()
     return {"result": lint_result.result, "checks": lint_result.checks}
 
 
-@app.post("/export", response_class=PlainTextResponse)
+@app.post(
+    "/export",
+    tags=["export"],
+    summary="Convert data contract to a specific format.",
+    response_class=PlainTextResponse,
+)
 def export(
-    file: Annotated[bytes, File()],
-    export_format: Annotated[ExportFormat, typer.Option(help="The export format.")],
-    server: Annotated[str, typer.Option(help="The server name to export.")] = None,
-    model: Annotated[
+    body: Annotated[
         str,
-        typer.Option(
-            help="Use the key of the model in the data contract yaml file "
+        Body(
+            title="Data Contract YAML",
+            media_type="application/yaml",
+            examples=[DATA_CONTRACT_EXAMPLE_PAYLOAD],
+        ),
+    ],
+    format: Annotated[ExportFormat, typer.Option(help="The export format.")],
+    server: Annotated[
+        str | None,
+        Query(
+            example="production",
+            description="The server name to export. Optional, if there is only one server.",
+        ),
+    ] = None,
+    model: Annotated[
+        str | None,
+        Query(
+            description="Use the key of the model in the data contract yaml file "
             "to refer to a model, e.g., `orders`, or `all` for all "
-            "models (default)."
+            "models (default).",
         ),
     ] = "all",
     rdf_base: Annotated[
@@ -51,14 +186,13 @@ def export(
     ] = None,
     sql_server_type: Annotated[
         Optional[str],
-        typer.Option(
-            help="[sql] The server type to determine the sql dialect. By default, it uses 'auto' to automatically detect the sql dialect via the specified servers in the data contract.",
-            rich_help_panel="SQL Options",
+        Query(
+            description="[sql] The server type to determine the sql dialect. By default, it uses 'auto' to automatically detect the sql dialect via the specified servers in the data contract.",
         ),
-    ] = "auto",
+    ] = None,
 ):
-    result = DataContract(data_contract_str=str(file, encoding="utf-8"), server=server).export(
-        export_format=export_format,
+    result = DataContract(data_contract_str=body, server=server).export(
+        export_format=format,
         model=model,
         rdf_base=rdf_base,
         sql_server_type=sql_server_type,

{datacontract_cli-0.10.19.dist-info → datacontract_cli-0.10.20.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: datacontract-cli
-Version: 0.10.19
+Version: 0.10.20
 Summary: The datacontract CLI is an open source command-line tool for working with Data Contracts. It uses data contract YAML files to lint the data contract, connect to data sources and execute schema and quality tests, detect breaking changes, and export to different formats. 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: Jochen Christ <jochen.christ@innoq.com>, Stefan Negele <stefan.negele@innoq.com>, Simon Harrer <simon.harrer@innoq.com>
 Project-URL: Homepage, https://cli.datacontract.com
@@ -15,8 +15,6 @@ Requires-Dist: typer<0.16,>=0.15.1
 Requires-Dist: pydantic<2.11.0,>=2.8.2
 Requires-Dist: pyyaml~=6.0.1
 Requires-Dist: requests<2.33,>=2.31
-Requires-Dist: fastapi==0.115.6
-Requires-Dist: uvicorn==0.34.0
 Requires-Dist: fastjsonschema<2.22.0,>=2.19.1
 Requires-Dist: fastparquet==2024.11.0
 Requires-Dist: numpy<2.0.0,>=1.26.4
@@ -65,8 +63,11 @@ Provides-Extra: dbml
 Requires-Dist: pydbml>=1.1.1; extra == "dbml"
 Provides-Extra: parquet
 Requires-Dist: pyarrow>=18.1.0; extra == "parquet"
+Provides-Extra: web
+Requires-Dist: fastapi==0.115.6; extra == "web"
+Requires-Dist: uvicorn==0.34.0; extra == "web"
 Provides-Extra: all
-Requires-Dist: datacontract-cli[bigquery,csv,databricks,dbml,dbt,iceberg,kafka,parquet,postgres,s3,snowflake,sqlserver,trino]; extra == "all"
+Requires-Dist: datacontract-cli[bigquery,csv,databricks,dbml,dbt,iceberg,kafka,parquet,postgres,s3,snowflake,sqlserver,trino,web]; extra == "all"
 Provides-Extra: dev
 Requires-Dist: datacontract-cli[all]; extra == "dev"
 Requires-Dist: httpx==0.28.1; extra == "dev"

{datacontract_cli-0.10.19.dist-info → datacontract_cli-0.10.20.dist-info}/RECORD

@@ -1,8 +1,8 @@
 datacontract/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-datacontract/cli.py,sha256=LCXFYd8kN4yrsgLlG8ZaYBkIRmbNWtpWaFH6GdgIMSo,17100
+datacontract/cli.py,sha256=rL860b_rNv7bDNnckljewhiDN6CTjsdRPLGRrXYLCa8,17103
 datacontract/data_contract.py,sha256=KzsF4xvMWZnyTrwL7YDE0_dYWrWG9Bn7efCmW3vK5SI,14767
 datacontract/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-datacontract/web.py,sha256=MePB-XJvTZObMzrk3tIW8-bAvk-QcEEt767RVos3Zoc,2105
+datacontract/web.py,sha256=EaAJunEkheyoaTx6Zxt4v6bQ-AuRNuaGYiDa0NiKURQ,6096
 datacontract/breaking/breaking.py,sha256=vUjPZzGsOF_ufTjdKa2T_gjQgPtZrZKytmcatkUr7ck,20428
 datacontract/breaking/breaking_rules.py,sha256=OKwYWCMkIob2uX8zxav7LbIhx_6RC4msioBjuNlox1k,4060
 datacontract/catalog/catalog.py,sha256=wmv_2BBxHhNBlilAmQHHhNe4tK14DowkyIOVaQW2DWU,2691
@@ -75,7 +75,7 @@ datacontract/lint/lint.py,sha256=Ew0n3ooXxmCVnUxJ_cDoacsD82QdMZYnKrxnG9J0sWQ,507
 datacontract/lint/resolve.py,sha256=_QtoAReUhiJ8I_4fyNimyUnHhpZGYmmDHFA59wUTeFw,10684
 datacontract/lint/resources.py,sha256=nfeZmORh1aP7EKpMKCmfbS04Te8pQ0nz64vJVkHOq3c,647
 datacontract/lint/schema.py,sha256=4pYX6JX6SkASftyqaWTodKFRVPi2qV0_Z60tvaCOk80,1813
-datacontract/lint/urls.py,sha256=W7Edcd8Iw4NjokVtuSshEfzsXshQpuh_tpO73aM9dsM,2294
+datacontract/lint/urls.py,sha256=dJDxvhJ_WaijbnkEKsF0EI3ptyP5BWC7RzDHJAK6v3k,2529
 datacontract/lint/linters/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 datacontract/lint/linters/description_linter.py,sha256=7fla7FQwDa-1UrLFCFKFoeUzkR91e4o9W6ySKSW6_U8,1555
 datacontract/lint/linters/example_model_linter.py,sha256=tmgxGxC-GzMUxFumTOuuASdz9ZlncBZHasPGJsWnDT8,3973
@@ -102,9 +102,9 @@ datacontract/templates/partials/example.html,sha256=F1dWbHDIXQScgfs4OVgqM1lR4uV4
 datacontract/templates/partials/model_field.html,sha256=QA0U95hHthEc66AjSYk4Di24hU-pHZbef0Sz-hSpdGM,7215
 datacontract/templates/partials/server.html,sha256=WkWFbz1ZvhIAUQQhH5Lkwb0HZRW907ehEnFmJSkpquQ,6235
 datacontract/templates/style/output.css,sha256=F3oEhUpuv8kA_dWr4pJymBS_Ju6huIIZdLMkJzPzMmU,25647
-datacontract_cli-0.10.19.dist-info/LICENSE,sha256=23h64qnSeIZ0DKeziWAKC-zBCt328iSbRbWBrXoYRb4,2210
-datacontract_cli-0.10.19.dist-info/METADATA,sha256=hF27km7hZIRpbFfD0rshENziv1IO80ZhVOGRXKLjF_k,98715
-datacontract_cli-0.10.19.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
-datacontract_cli-0.10.19.dist-info/entry_points.txt,sha256=D3Eqy4q_Z6bHauGd4ppIyQglwbrm1AJnLau4Ppbw9Is,54
-datacontract_cli-0.10.19.dist-info/top_level.txt,sha256=VIRjd8EIUrBYWjEXJJjtdUgc0UAJdPZjmLiOR8BRBYM,13
-datacontract_cli-0.10.19.dist-info/RECORD,,
+datacontract_cli-0.10.20.dist-info/LICENSE,sha256=23h64qnSeIZ0DKeziWAKC-zBCt328iSbRbWBrXoYRb4,2210
+datacontract_cli-0.10.20.dist-info/METADATA,sha256=3VPkCNDzKqXRh0jS5qi2WwKuhVfwERgKOsBnkSv_h-c,98771
+datacontract_cli-0.10.20.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+datacontract_cli-0.10.20.dist-info/entry_points.txt,sha256=D3Eqy4q_Z6bHauGd4ppIyQglwbrm1AJnLau4Ppbw9Is,54
+datacontract_cli-0.10.20.dist-info/top_level.txt,sha256=VIRjd8EIUrBYWjEXJJjtdUgc0UAJdPZjmLiOR8BRBYM,13
+datacontract_cli-0.10.20.dist-info/RECORD,,