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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: datacontract-cli
-Version: 0.10.19
+Version: 0.10.21
 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
@@ -51,7 +49,7 @@ Provides-Extra: postgres
 Requires-Dist: soda-core-postgres<3.4.0,>=3.3.20; extra == "postgres"
 Provides-Extra: s3
 Requires-Dist: s3fs==2024.12.0; extra == "s3"
-Requires-Dist: aiobotocore<2.18.0,>=2.17.0; extra == "s3"
+Requires-Dist: aiobotocore<2.20.0,>=2.17.0; extra == "s3"
 Provides-Extra: snowflake
 Requires-Dist: snowflake-connector-python[pandas]<3.13,>=3.6; extra == "snowflake"
 Requires-Dist: soda-core-snowflake<3.4.0,>=3.3.20; extra == "snowflake"
@@ -65,13 +63,18 @@ Provides-Extra: dbml
 Requires-Dist: pydbml>=1.1.1; extra == "dbml"
 Provides-Extra: parquet
 Requires-Dist: pyarrow>=18.1.0; extra == "parquet"
+Provides-Extra: api
+Requires-Dist: fastapi==0.115.6; extra == "api"
+Requires-Dist: uvicorn==0.34.0; extra == "api"
+Provides-Extra: custom
+Requires-Dist: Jinja2>=3.1.5; extra == "custom"
 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[api,bigquery,csv,custom,databricks,dbml,dbt,iceberg,kafka,parquet,postgres,s3,snowflake,sqlserver,trino]; extra == "all"
 Provides-Extra: dev
 Requires-Dist: datacontract-cli[all]; extra == "dev"
 Requires-Dist: httpx==0.28.1; extra == "dev"
 Requires-Dist: kafka-python; extra == "dev"
-Requires-Dist: moto==5.0.26; extra == "dev"
+Requires-Dist: moto==5.0.27; extra == "dev"
 Requires-Dist: pandas>=2.1.0; extra == "dev"
 Requires-Dist: pre-commit<4.1.0,>=3.7.1; extra == "dev"
 Requires-Dist: pytest; extra == "dev"
@@ -304,7 +307,7 @@ Commands
 - [diff](#diff)
 - [catalog](#catalog)
 - [publish](#publish)
-- [serve](#serve)
+- [api](#api)
 
 ### init
 ```
@@ -880,7 +883,7 @@ models:
 │                    vro-idl|sql|sql-query|html|                               │
 │                    go|bigquery|dbml|spark|sqla                               │
 │                    lchemy|data-caterer|dcs|mar                               │
-│                    kdown|iceberg]                                            │
+│                    kdown|iceberg|custom]                                     │
 │    --output        PATH                         Specify the file path where  │
 │                                                 the exported data will be    │
 │                                                 saved. If no path is         │
@@ -903,6 +906,9 @@ models:
 │    --engine        TEXT                         [engine] The engine used for │
 │                                                 great expection run.         │
 │                                                 [default: None]              │
+│    --template      PATH                         [custom] The file path of    │
+│                                                 Jinja template.              │
+│                                                 [default: None]              │
 │    --help                                       Show this message and exit.  │
 ╰──────────────────────────────────────────────────────────────────────────────╯
 ╭─ RDF Options ────────────────────────────────────────────────────────────────╮
@@ -954,6 +960,7 @@ Available export options:
 | `dcs`                | Export to Data Contract Specification in YAML format    | ✅      |
 | `markdown`           | Export to Markdown                                      | ✅      |
 | `iceberg`            | Export to an Iceberg JSON Schema Definition             | partial |
+| `custom`             | Export to Custom format with Jinja                      | ✅      |
 | Missing something?   | Please create an issue on GitHub                        | TBD    |
 
 
@@ -1135,6 +1142,76 @@ to limit your contract export to a single model.
 }
 ```
 
+#### Custom
+
+The export function converts the data contract specification into the custom format with Jinja. You can specify the path to a Jinja template with the `--template` argument, allowing you to output files in any format.
+
+```shell
+datacontract export --format custom --template template.txt datacontract.yaml
+```
+
+##### Jinja variables
+
+You can directly use the Data Contract Specification as template variables.
+
+```shell
+$ cat template.txt
+title: {{ data_contract.info.title }}
+
+$ datacontract export --format custom --template template.txt datacontract.yaml
+title: Orders Latest
+```
+
+##### Example Jinja Templates
+
+###### Customized dbt model
+
+You can export the dbt models containing any logic.
+
+Below is an example of a dbt staging layer that converts a field of `type: timestamp` to a `DATETIME` type with time zone conversion.
+
+template.sql
+
+{% raw %}
+```sql
+{%- for model_name, model in data_contract.models.items() %}
+{#- Export only the first model #}
+{%- if loop.first -%}
+SELECT
+{%- for field_name, field in model.fields.items() %}
+  {%- if field.type == "timestamp" %}
+  DATETIME({{ field_name }}, "Asia/Tokyo") AS {{ field_name }},
+  {%- else %}
+  {{ field_name }} AS {{ field_name }},
+  {%- endif %}
+{%- endfor %}
+FROM
+  {{ "{{" }} ref('{{ model_name }}') {{ "}}" }} 
+{%- endif %}
+{%- endfor %}
+```
+{% endraw %}
+
+command
+
+```shell
+datacontract export --format custom --template template.sql --output output.sql datacontract.yaml
+```
+
+output.sql
+
+```sql
+SELECT
+  order_id AS order_id,
+  DATETIME(order_timestamp, "Asia/Tokyo") AS order_timestamp,
+  order_total AS order_total,
+  customer_id AS customer_id,
+  customer_email_address AS customer_email_address,
+  DATETIME(processed_timestamp, "Asia/Tokyo") AS processed_timestamp,
+FROM
+  {{ ref('orders') }}
+```
+
 ### import
 ```
                                                                                 
@@ -1539,18 +1616,23 @@ datacontract catalog --files "*.odcs.yaml"
 
 ```
 
-### serve
+### api
 ```
-                                                                                
- Usage: datacontract serve [OPTIONS]                                            
-                                                                                
- Start the datacontract web server.                                             
-                                                                                
-╭─ Options ────────────────────────────────────────────────────────────────────╮
-│ --port        INTEGER  Bind socket to this port. [default: 4242]             │
-│ --host        TEXT     Bind socket to this host. [default: 127.0.0.1]        │
-│ --help                 Show this message and exit.                           │
-╰──────────────────────────────────────────────────────────────────────────────╯
+
+ Usage: datacontract api [OPTIONS]   
+                                                                                 
+ Start the datacontract CLI as server application with REST API.                                                                                                                  
+ The OpenAPI documentation as Swagger UI is available on http://localhost:4242. You can execute the commands directly from the Swagger UI.                                        
+ To protect the API, you can set the environment variable DATACONTRACT_CLI_API_KEY to a secret API key. To authenticate, requests must include the header 'x-api-key' with the    
+ correct API key. This is highly recommended, as data contract tests may be subject to SQL injections or leak sensitive information.                                              
+ To connect to servers (such as a Snowflake data source), set the credentials as environment variables as documented in https://cli.datacontract.com/#test                        
+                                                                                                                                                                                  
+╭─ Options ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
+│ --port        INTEGER  Bind socket to this port. [default: 4242]                                                                                                               │
+│ --host        TEXT     Bind socket to this host. Hint: For running in docker, set it to 0.0.0.0 [default: 127.0.0.1]                                                           │
+│ --help                 Show this message and exit.                                                                                                                             │
+╰────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
+
 
 ```
 
@@ -1708,7 +1790,7 @@ class CustomExporter(Exporter):
 
 
 # Register the new custom class into factory
-exporter_factory.register_exporter("custom", CustomExporter)
+exporter_factory.register_exporter("custom_exporter", CustomExporter)
 
 
 if __name__ == "__main__":
@@ -1718,7 +1800,7 @@ if __name__ == "__main__":
     )
     # Call export
     result = data_contract.export(
-        export_format="custom", model="orders", server="production", custom_arg="my_custom_arg"
+        export_format="custom_exporter", model="orders", server="production", custom_arg="my_custom_arg"
     )
     print(result)
 

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

@@ -1,8 +1,8 @@
 datacontract/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-datacontract/cli.py,sha256=LCXFYd8kN4yrsgLlG8ZaYBkIRmbNWtpWaFH6GdgIMSo,17100
+datacontract/api.py,sha256=qZJr8I5MI4wZlvjUEAvqna9Xj5Ic2GCBxSyogBlKEbE,8166
+datacontract/cli.py,sha256=5pt8xYYezGyCT5YM_N4rwtm6bkY5q-j0PuQVAzJg5fc,18174
 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/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
@@ -27,12 +27,13 @@ datacontract/export/avro_converter.py,sha256=xNRo0eXR3n--EA8SziarWqhlvOYtQWkWJtE
 datacontract/export/avro_idl_converter.py,sha256=SGO7JfI9UGXLYFR5wMGNUH1qf6kt9lF6dUU9roVqnFo,9878
 datacontract/export/bigquery_converter.py,sha256=VSBdVGWrlar18ETzgNArxDzk8Zt5JcAc_wKjfwLpG_A,4734
 datacontract/export/csv_type_converter.py,sha256=ZZuJwBgQnafZC7PPvAXsBf2IajPJq8TYZ1l8Qq0GYeI,1290
+datacontract/export/custom_converter.py,sha256=xb8KbkRRgHmT4ewwC7XxtnKpe_ZMSJWBjYOaKjmO_KQ,1216
 datacontract/export/data_caterer_converter.py,sha256=eSEuy3TbqUIG_lHYEBOydAgp_CJNoGArXrcJvh81wcw,5984
 datacontract/export/dbml_converter.py,sha256=f_OZEFwRUyL-Kg2yn_G58I8iz1VfFrZh8Nbw3Wq0JDo,4777
 datacontract/export/dbt_converter.py,sha256=BPvcKyT-v1C_zcYh8ocn5qeNVUjTjYIcMVxnq8BY-Us,10342
 datacontract/export/dcs_exporter.py,sha256=RALQ7bLAjak7EsoFFL2GFX2Oju7pnCDPCdRN_wo9wHM,210
-datacontract/export/exporter.py,sha256=b9z5vjY5dsc0Nw-gG03RkNYyOuidMk-RGkS9GAE-elk,3051
-datacontract/export/exporter_factory.py,sha256=sW6-43FiOFTzqgho2jvSzhd7_PGqWApfKOnfFFzjs90,6021
+datacontract/export/exporter.py,sha256=kRg1Ka6t9g2PuTZJyYSah0l0SfBXO9X6_FUuHDjs81o,3073
+datacontract/export/exporter_factory.py,sha256=IhLqLiBNDtP1PpaOxu1OqlbRfpeBoWYqomrv97LlRz8,6175
 datacontract/export/go_converter.py,sha256=Ttvbfu3YU-3GBwRD6nwCsFyZuc_hiIvJD-Jg2sT5WLw,3331
 datacontract/export/great_expectations_converter.py,sha256=zMaHaj5DLj_Q_q-iFEa7EZHW-qHdFMxWL4MiMIFKV80,10505
 datacontract/export/html_export.py,sha256=ojazWrb0AwSc7Vr72M_otMo-3PA8mfi8tfIy9BCXk9o,2578
@@ -75,7 +76,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=giac0eAYa6hha8exleL3KsiPtiFlOq8l53axtAmCilw,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
@@ -85,26 +86,27 @@ datacontract/lint/linters/notice_period_linter.py,sha256=6r413aEVOVHWJHb33-68ecV
 datacontract/lint/linters/quality_schema_linter.py,sha256=ZXFHlMLFV1GZejizbUdfW6-msffFECoDGNsdynaPnog,2182
 datacontract/lint/linters/valid_constraints_linter.py,sha256=qTFh1X3I9wOtAxuXlvbGesCQ3GQ6iWc-MT_ttIybRsw,4916
 datacontract/model/breaking_change.py,sha256=BIDEUo1U2CQLVT2-I5PyFttxAj6zQPI1UUkEoOOQXMY,2249
-datacontract/model/data_contract_specification.py,sha256=HsHllx4-Uk-K9LSQspja9OwI2fSavzAsZ4C4pfuPl48,8123
+datacontract/model/data_contract_specification.py,sha256=1bEE7hQJEjzoL4XtCQBmPe6VWclU_D_YiUJW2oNRNos,8655
 datacontract/model/exceptions.py,sha256=zW9NoyzwsND-c9UqgyTVuezUVGEc6KK1Uc2zl12loyo,1178
 datacontract/model/odcs.py,sha256=9PXwm72FASjNwteF1Jn591iP3-St0aq16Cpsk0PkEW8,389
-datacontract/model/run.py,sha256=zIosfMAKB3WVsWN3UcFQteHaQ04SlYZX45opaRXklNw,2827
+datacontract/model/run.py,sha256=LGYlMlS5NlNhkBE10n_U6DEqaiLybag6Og_RZ_W9xgs,2826
 datacontract/schemas/datacontract-1.1.0.init.yaml,sha256=_WQX6NRwimXlPVKcKeHLd4mFL0TJ2vYH0WnyMXZeQ8Y,1828
 datacontract/schemas/datacontract-1.1.0.schema.json,sha256=3Bu2rxEjkF6dNLcqi1GF4KoXBnEIopaJ87Qb8S4zUvg,62872
 datacontract/schemas/odcs-3.0.1.schema.json,sha256=bRZsSXA0fV0EmV_8f1K68PlXu1m4K7JcuHpLnY3ESwQ,72933
-datacontract/templates/datacontract.html,sha256=gCq5pfFR-L9DLznVjrUlvyQe597h5lZzD7xpQum_OEM,14534
+datacontract/templates/datacontract.html,sha256=9rm5hLkST8EnOFwj0al9c0xPajzlyWlnfxT2iicSRCM,15179
 datacontract/templates/index.html,sha256=nyi9nrEsSPuOrXszKzqkqwZGveXsdy1PLJp2g9oDw0A,12517
 datacontract/templates/partials/datacontract_information.html,sha256=7ZBxgEgi2XndKBypeOpe03oCSRPOujC6NVlN7zexGNM,6221
 datacontract/templates/partials/datacontract_servicelevels.html,sha256=ed3QgB11B0Qq2h_NwaroGZ4pQMBPEhfeQaoS-qEipqY,11401
 datacontract/templates/partials/datacontract_terms.html,sha256=1cnJcOTpxwot2BCuZmkLF_SPfiVloLs3c8mj9WfE4sc,1865
-datacontract/templates/partials/definition.html,sha256=SveQlfdTyCHuAu3455VXL8_Cgv298lD_dgtdwA_YaAg,7461
+datacontract/templates/partials/definition.html,sha256=gZEmNvwNGGxA_Fnzx_0L6tXlAMk_EAPWr5ziRIThb_o,1005
 datacontract/templates/partials/example.html,sha256=F1dWbHDIXQScgfs4OVgqM1lR4uV4xX5j6suasXHNM88,1204
-datacontract/templates/partials/model_field.html,sha256=QA0U95hHthEc66AjSYk4Di24hU-pHZbef0Sz-hSpdGM,7215
+datacontract/templates/partials/model_field.html,sha256=2YBF95ypNCPFYuYKoeilRnDG-H_FuW4JK1znkCaYCac,7625
+datacontract/templates/partials/quality.html,sha256=ynEDWRn8I90Uje-xhGYgFcfwOgKI1R-CDki-EvTsauQ,1785
 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/templates/style/output.css,sha256=V1k6smSvlz07W2UNOkhcDFUb0HLmoas7DnNg_o8XUcA,25759
+datacontract_cli-0.10.21.dist-info/LICENSE,sha256=23h64qnSeIZ0DKeziWAKC-zBCt328iSbRbWBrXoYRb4,2210
+datacontract_cli-0.10.21.dist-info/METADATA,sha256=uquXgiucFDTjcXNkkj04No0TxtEjo9fOU7bgrot8qVY,102667
+datacontract_cli-0.10.21.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+datacontract_cli-0.10.21.dist-info/entry_points.txt,sha256=D3Eqy4q_Z6bHauGd4ppIyQglwbrm1AJnLau4Ppbw9Is,54
+datacontract_cli-0.10.21.dist-info/top_level.txt,sha256=VIRjd8EIUrBYWjEXJJjtdUgc0UAJdPZjmLiOR8BRBYM,13
+datacontract_cli-0.10.21.dist-info/RECORD,,

datacontract/web.py

@@ -1,67 +0,0 @@
-from typing import Annotated, Optional, Union
-
-import typer
-from fastapi import FastAPI, File
-from fastapi.responses import HTMLResponse, PlainTextResponse
-
-from datacontract.data_contract import DataContract, ExportFormat
-
-app = FastAPI()
-
-
-@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("/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)
-    return {"result": lint_result.result, "checks": lint_result.checks}
-
-
-@app.post("/export", 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[
-        str,
-        typer.Option(
-            help="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)."
-        ),
-    ] = "all",
-    rdf_base: Annotated[
-        Optional[str],
-        typer.Option(help="[rdf] The base URI used to generate the RDF graph.", rich_help_panel="RDF Options"),
-    ] = 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",
-        ),
-    ] = "auto",
-):
-    result = DataContract(data_contract_str=str(file, encoding="utf-8"), server=server).export(
-        export_format=export_format,
-        model=model,
-        rdf_base=rdf_base,
-        sql_server_type=sql_server_type,
-    )
-
-    return result