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

datacontract/templates/datacontract.html

@@ -125,9 +125,18 @@
                       <thead class="bg-gray-50">
                       <tr>
                         <th scope="colgroup" colspan="3" class="py-2 pl-4 pr-3 text-left font-semibold text-gray-900 sm:pl-6">
-                          <span>{{ model_name }}</span>
+                          {% if model.title %}
+                          {{ model.title }}
+                          {% endif %}
+                          {% if model.title != model_name %}
+                          <span class="font-mono font-medium">{{ model_name }}</span>
+                          {% endif %}
                           <span class="inline-flex items-center rounded-md bg-gray-50 px-2 py-1 text-xs font-medium text-gray-600 ring-1 ring-inset ring-gray-500/10">{{ model.type }}</span>
                           <div class="text-sm font-medium text-gray-500">{{ model.description }}</div>
+                          {% for key, value in model.model_extra.items() %}
+                          <span
+                            class="inline-flex items-center rounded-md bg-blue-50 px-1 py-1 text-xs font-medium text-blue-600 ring-1 ring-inset ring-blue-500/10 mr-1 mt-1">{{ key }}: {{ value }}</span>
+                          {% endfor %}
                         </th>
 
                       </tr>
@@ -137,6 +146,16 @@
                         {{ render_partial('partials/model_field.html', nested = False, field_name=field_name, field = field, level = 0) }}
                       {% endfor %}
                       </tbody>
+                      {% if model.primaryKey %}
+                      <tfoot class="bg-gray-50">
+                      <tr>
+                        <th scope="colgroup" colspan="4"
+                            class="py-2 pl-4 pr-3 text-left text-sm font-semibold text-gray-900 sm:pl-6">
+                          <span>Primary Key: {{ model.primaryKey }}</span>
+                        </th>
+                      </tr>
+                      </tfoot>
+                      {% endif %}
                     </table>
                   </div>
                 </div>

datacontract/templates/partials/definition.html

@@ -20,7 +20,7 @@
                   {% if definition.title %}
                   <div>{{ definition.title }}</div>
                   {% endif %}
-                  <div class="font-mono">{{ definition.name }}</div>
+                  <div class="font-mono">{{ definition_name }}</div>
                 </div>
               </td>
               <td class="whitespace-nowrap px-1 py-2 text-sm text-gray-500 w-1/12">
@@ -33,13 +33,23 @@
               </td>
               <td class="px-3 py-2 text-sm text-gray-500 w-9/12">
                 {% if definition.example %}
-                <div class="mt-1">
-                  <span class="text-gray-600 font-medium">Example:</span> <span class="font-mono">{{ definition.example }}</span>
+                <div class="mt-1 italic">
+                  <span class="text-gray-600">Example:</span> <span class="font-mono">{{ definition.example }}</span>
                 </div>
                 {% endif %}
+
+                {% if definition.examples %}
+                <div class="mt-1 italic">
+                  <span class="text-gray-600">Examples:</span>
+                  {% for example in definition.examples %}
+                  <span class="font-mono">{{ example }}</span>{% if not loop.last %}, {% endif %}
+                  {% endfor %}
+                </div>
+                {% endif %}
+
                 {% if definition.tags %}
                 <div>
-                  <span class="text-gray-600 font-medium">Tags:</span>
+                  <span class="text-gray-600 italic">Tags:</span>
                   {% for tag in definition.tags %}
                   <span class="inline-flex items-center rounded-md bg-gray-50 px-1 py-1 text-xs font-medium text-gray-600 ring-1 ring-inset ring-gray-500/10 mr-1 mt-1">{{ tag }}</span>
                   {% endfor %}
@@ -47,7 +57,7 @@
                 {% endif %}
                 {% if definition.enum %}
                 <div class="py-2 text-sm">
-                  <span class="text-gray-600 font-medium">Enum:</span>
+                  <span class="text-gray-600 italic">Enum:</span>
                   {% for value in definition.enum %}
                   <span class="inline-flex items-center rounded-md bg-gray-50 px-1 py-1 text-xs font-medium text-gray-600 ring-1 ring-inset ring-gray-500/10 mr-1 mt-1">{{ value }}</span>
                   {% endfor %}

datacontract/templates/partials/model_field.html

@@ -39,6 +39,15 @@
     </div>
     {% endif %}
 
+    {% if field.examples %}
+    <div class="mt-1 italic">
+      Examples:
+      {% for example in field.examples %}
+      <span class="font-mono">{{ example }}</span>{% if not loop.last %}, {% endif %}
+      {% endfor %}
+    </div>
+    {% endif %}
+
     <div>
       {% if field.primaryKey or field.primary %}
       <span class="inline-flex items-center rounded-md bg-gray-50 px-1 py-1 text-xs font-medium text-gray-600 ring-1 ring-inset ring-gray-500/10 mr-1 mt-1">primary</span>

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,