vgi-python 0.12.0__tar.gz → 0.13.0__tar.gz

{vgi_python-0.12.0 → vgi_python-0.13.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: vgi-python
-Version: 0.12.0
+Version: 0.13.0
 Summary: Vector Gateway Interface - Connect DuckDB to external programs via Apache Arrow
 Project-URL: Homepage, https://query.farm
 Project-URL: Repository, https://github.com/Query-farm/vgi-python

{vgi_python-0.12.0 → vgi_python-0.13.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "vgi-python"
-version = "0.12.0"
+version = "0.13.0"
 description = "Vector Gateway Interface - Connect DuckDB to external programs via Apache Arrow"
 readme = "README.md"
 keywords = [

{vgi_python-0.12.0 → vgi_python-0.13.0}/tests/landing/describe.expected.json

@@ -14,6 +14,7 @@
       "name": "example",
       "schemas": [
         {
+          "doc": "Example tables backed by functions",
           "functions": [],
           "name": "data",
           "tables": [
@@ -248,6 +249,7 @@
           ]
         },
         {
+          "doc": "Example functions for testing VGI",
           "functions": [
             {
               "args": [

vgi_python-0.13.0/tests/landing/describe.schema.json

@@ -0,0 +1,402 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://query.farm/vgi/describe.schema.json",
+  "title": "VGI worker describe.json (landing contract)",
+  "description": "Validates GET {prefix}/describe.json. See docs/http-landing-contract.md.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "landing_schema_version",
+    "worker",
+    "server_id",
+    "oauth",
+    "cupola_base",
+    "catalogs"
+  ],
+  "properties": {
+    "landing_schema_version": {
+      "type": "integer",
+      "minimum": 1
+    },
+    "worker": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "name",
+        "doc",
+        "version",
+        "lang"
+      ],
+      "properties": {
+        "name": {
+          "type": "string"
+        },
+        "doc": {
+          "type": "string"
+        },
+        "version": {
+          "type": "string"
+        },
+        "lang": {
+          "enum": [
+            "python",
+            "go",
+            "rust",
+            "typescript",
+            "java"
+          ]
+        }
+      }
+    },
+    "server_id": {
+      "type": "string"
+    },
+    "oauth": {
+      "type": "boolean"
+    },
+    "cupola_base": {
+      "type": "string",
+      "format": "uri"
+    },
+    "catalogs": {
+      "type": "array",
+      "items": {
+        "$ref": "#/$defs/catalog"
+      }
+    }
+  },
+  "$defs": {
+    "catalog": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "name",
+        "implementation_version",
+        "data_version_spec",
+        "data_versions",
+        "attach_options",
+        "tags",
+        "counts",
+        "schemas"
+      ],
+      "properties": {
+        "name": {
+          "type": "string"
+        },
+        "implementation_version": {
+          "type": [
+            "string",
+            "null"
+          ]
+        },
+        "data_version_spec": {
+          "type": [
+            "string",
+            "null"
+          ]
+        },
+        "data_versions": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/dataVersion"
+          }
+        },
+        "attach_options": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/attachOption"
+          }
+        },
+        "tags": {
+          "$ref": "#/$defs/tags"
+        },
+        "counts": {
+          "$ref": "#/$defs/counts"
+        },
+        "schemas": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/schema"
+          }
+        }
+      }
+    },
+    "dataVersion": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "spec"
+      ],
+      "properties": {
+        "spec": {
+          "type": "string"
+        },
+        "label": {
+          "type": "string"
+        }
+      }
+    },
+    "attachOption": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "name",
+        "type",
+        "default",
+        "description"
+      ],
+      "properties": {
+        "name": {
+          "type": "string"
+        },
+        "type": {
+          "type": "string"
+        },
+        "default": {
+          "type": "string"
+        },
+        "description": {
+          "type": "string"
+        }
+      }
+    },
+    "tags": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "title": {
+          "type": "string"
+        },
+        "doc_md": {
+          "type": "string"
+        },
+        "source_url": {
+          "type": "string"
+        },
+        "license": {
+          "type": "string"
+        },
+        "author": {
+          "type": "string"
+        },
+        "copyright": {
+          "type": "string"
+        },
+        "support_contact": {
+          "type": "string"
+        },
+        "support_policy_url": {
+          "type": "string"
+        },
+        "keywords": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        }
+      }
+    },
+    "counts": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "schemas",
+        "tables",
+        "views",
+        "functions"
+      ],
+      "properties": {
+        "schemas": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "tables": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "views": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "functions": {
+          "type": "integer",
+          "minimum": 0
+        }
+      }
+    },
+    "schema": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "name",
+        "tables",
+        "views",
+        "functions"
+      ],
+      "properties": {
+        "name": {
+          "type": "string"
+        },
+        "doc": {
+          "type": "string",
+          "description": "Schema comment/description (optional, may be Markdown)"
+        },
+        "tables": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/table"
+          }
+        },
+        "views": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/view"
+          }
+        },
+        "functions": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/function"
+          }
+        }
+      }
+    },
+    "table": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "name",
+        "cols",
+        "comment"
+      ],
+      "properties": {
+        "name": {
+          "type": "string"
+        },
+        "cols": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "comment": {
+          "type": "string"
+        }
+      }
+    },
+    "view": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "name",
+        "cols",
+        "comment",
+        "def"
+      ],
+      "properties": {
+        "name": {
+          "type": "string"
+        },
+        "cols": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "comment": {
+          "type": "string"
+        },
+        "def": {
+          "type": "string"
+        }
+      }
+    },
+    "function": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "name",
+        "type",
+        "doc",
+        "args"
+      ],
+      "properties": {
+        "name": {
+          "type": "string"
+        },
+        "type": {
+          "enum": [
+            "scalar",
+            "table",
+            "aggregate",
+            "table_in_out"
+          ]
+        },
+        "doc": {
+          "type": "string"
+        },
+        "args": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/arg"
+          }
+        },
+        "returns": {
+          "type": "string"
+        }
+      }
+    },
+    "arg": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "name",
+        "type"
+      ],
+      "properties": {
+        "name": {
+          "type": "string"
+        },
+        "type": {
+          "type": "string"
+        },
+        "named": {
+          "type": "boolean"
+        },
+        "default": {
+          "type": "string"
+        },
+        "desc": {
+          "type": "string"
+        }
+      }
+    },
+    "columns": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "columns"
+      ],
+      "properties": {
+        "columns": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+              "name",
+              "type"
+            ],
+            "properties": {
+              "name": {
+                "type": "string"
+              },
+              "type": {
+                "type": "string"
+              },
+              "comment": {
+                "type": "string"
+              }
+            }
+          }
+        }
+      }
+    }
+  }
+}

{vgi_python-0.12.0 → vgi_python-0.13.0}/uv.lock

@@ -2228,7 +2228,7 @@ requires-dist = [
 
 [[package]]
 name = "vgi-python"
-version = "0.12.0"
+version = "0.13.0"
 source = { editable = "." }
 dependencies = [
     { name = "click" },

{vgi_python-0.12.0 → vgi_python-0.13.0}/vgi/http/describe_json.py

@@ -332,7 +332,10 @@ def _build_schemas(
         # same scalar/table/aggregate/table_in_out buckets on the landing page).
         functions.sort(key=lambda d: (d["type"], d["name"]))
 
-        schemas.append({"name": si.name, "tables": tables, "views": views, "functions": functions})
+        schema_entry: dict[str, Any] = {"name": si.name, "tables": tables, "views": views, "functions": functions}
+        if si.comment:
+            schema_entry["doc"] = si.comment
+        schemas.append(schema_entry)
         totals["schemas"] += 1
         totals["tables"] += len(tables)
         totals["views"] += len(views)