Initial commit

.github/workflows/build-and-publish.yml

@@ -0,0 +1,22 @@
+name: release
+on:
+  release:
+    types: [published]
+jobs:
+  publish:
+    environment: release       # needed for PyPI OIDC
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/checkout@v4
+        name: checkout
+      - name: Install uv
+        uses: astral-sh/setup-uv@v2
+      - name: "Set up Python"
+        uses: actions/setup-python@v5
+        with:
+          python-version-file: "pyproject.toml"
+      - name: Install dependencies
+        run:  uv build  # build
+      - uses: pypa/gh-action-pypi-publish@release/v1    # publish

.github/workflows/codeql-analysis.yml

@@ -0,0 +1,70 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ main ]
+  schedule:
+    - cron: '42 15 * * 5'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'python' ]
+        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
+        # Learn more about CodeQL language support at https://git.io/codeql-language-support
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v2
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v2
+      with:
+        languages: ${{ matrix.language }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
+        # queries: ./path/to/local/query, your-org/your-repo/queries@main
+
+    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+    # If this step fails, then you should remove it and run the build manually (see below)
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v2
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 https://git.io/JvXDl
+
+    # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
+    #    and modify them (or add more) to build your code if your project
+    #    uses a compiled language
+
+    #- run: |
+    #   make bootstrap
+    #   make release
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v2

.github/workflows/test.yml

@@ -0,0 +1,35 @@
+name: test
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+    types: [opened, reopened, synchronize]
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ['3.10', '3.11', '3.12']
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install uv
+        uses: astral-sh/setup-uv@v2
+      - name: Set up Python ${{ matrix.python-version }}
+        run: uv python install ${{ matrix.python-version }} && uv python pin ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: uv venv && uv sync
+      - name: Run tests
+        run: |
+          source .venv/bin/activate
+          uv run pytest --junitxml=junit/report.xml --cov=.
+      - name: Publish Test Report
+        uses: mikepenz/action-junit-report@v3
+        if: always() # always run even if the previous step fails
+        with:
+          report_paths: "junit/report.xml"
+      - name: Upload Coverage to Codecov
+        uses: codecov/codecov-action@v3
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          files: ./coverage.xml

.gitignore

@@ -0,0 +1,4 @@
+.envrc
+.coverage
+.idea/
+__pycache__/

.python-version

@@ -0,0 +1 @@
+3.10

README.md

@@ -1,2 +1,37 @@
-# pyarrow-unity
-Create unity catalog schema from Pyarrow dataframe
+## pyarrow-unity
+
+This library provides functions to convert Pyarrow schema to Unity Catalog schema.  
+
+## Installation
+```bash
+pip install pyarrow-unity
+```
+
+## Functions
+**model_unity_schema(schema)**
+Converts a Pyarrow schema to a list of Unity Catalog columns.  
+
+**Parameters:**  
+- schema: The Pyarrow schema to convert.
+
+**Returns:**
+A list of Column objects representing the Unity Catalog schema.
+
+**Example:**
+```python
+import pyarrow as pa
+from pyarrow_unity.model import model_unity_schema
+
+schema = pa.schema([
+    pa.field('col1', pa.int32(), nullable=True),
+    pa.field('col2', pa.string(), nullable=False),
+    pa.field('col3', pa.decimal128(10, 2), nullable=True)
+])
+
+columns = model_unity_schema(schema)
+for column in columns:
+    print(f"Name: {column.name}, Type: {column.type_name}, Nullable: {column.nullable}")
+```
+
+## License
+This project is licensed under the MIT License - see the [LICENSE](license) file for details.

pyproject.toml

@@ -0,0 +1,36 @@
+[project]
+name = "pyarrow-unity"
+version = "0.1.0"
+description = "Convert Pyarrow schema to Unity Catalog schema"
+readme = "README.md"
+authors = [{name = "Frank Mbonu", email = "[email protected]"}, {name = "Frank Mbonu", email = "[email protected]"}]
+
+requires-python = ">=3.10"
+dependencies = [
+    "pyarrow>=17.0.0",
+    "unitycatalog>=0.1.1",
+]
+
+[tool.uv]
+dev-dependencies = [
+    "coverage>=7.6.1",
+    "pre-commit>=3.8.0",
+    "pytest-cov>=5.0.0",
+    "pytest>=8.3.3",
+    "ruff>=0.6.5",
+]
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.sdist]
+include = [
+    "/src/pyarrow_unity",
+]
+[tool.ruff]
+line-length = 88
+lint.select = ["E", "F", "W", "C90"]
+lint.ignore = ["E501"]
+lint.per-file-ignores = {"__init__.py" = ["F401", "F403"]}
+exclude = ["build", "dist", "venv"]

src/pyarrow_unity/model.py

@@ -0,0 +1,108 @@
+import json
+from typing import Literal
+
+import pyarrow as pa
+
+from unitycatalog.types.table_create_params import Column
+
+UCSupportedTypeLiteral = Literal[
+    "BOOLEAN",
+    "BYTE",
+    "SHORT",
+    "INT",
+    "LONG",
+    "FLOAT",
+    "DOUBLE",
+    "DATE",
+    "TIMESTAMP",
+    "TIMESTAMP_NTZ",
+    "STRING",
+    "BINARY",
+    "DECIMAL",
+    "INTERVAL",
+    "ARRAY",
+    "STRUCT",
+    "MAP",
+    "CHAR",
+    "NULL",
+    "USER_DEFINED_TYPE",
+    "TABLE_TYPE",
+]
+
+UCSupportedFormatLiteral = Literal["DELTA", "CSV", "JSON", "AVRO", "PARQUET", "ORC", "TEXT"]
+
+
+def pyarrow_to_uc_type(data_type: pa.DataType) -> UCSupportedTypeLiteral:
+    """Convert a PyArrow data type to a supported Unitycatalog JSON type."""
+    if pa.types.is_boolean(data_type):
+        return "BOOLEAN"
+    elif pa.types.is_int8(data_type):
+        return "BYTE"
+    elif pa.types.is_int16(data_type):
+        return "SHORT"
+    elif pa.types.is_int32(data_type):
+        return "INT"
+    elif pa.types.is_int64(data_type):
+        return "LONG"
+    elif pa.types.is_float32(data_type):
+        return "FLOAT"
+    elif pa.types.is_float64(data_type):
+        return "DOUBLE"
+    elif pa.types.is_date32(data_type):
+        return "DATE"
+    elif pa.types.is_timestamp(data_type):
+        return "TIMESTAMP"
+    elif pa.types.is_string(data_type):
+        return "STRING"
+    elif pa.types.is_binary(data_type):
+        return "BINARY"
+    elif pa.types.is_decimal(data_type):
+        return "DECIMAL"
+    elif pa.types.is_duration(data_type):
+        return "INTERVAL"
+    elif pa.types.is_list(data_type):
+        return "ARRAY"
+    elif pa.types.is_struct(data_type):
+        return "STRUCT"
+    elif pa.types.is_map(data_type):
+        return "MAP"
+    elif pa.types.is_null(data_type):
+        return "NULL"
+    else:
+        raise NotImplementedError(f"Type {data_type} not supported")
+
+def model_unity_schema(schema: pa.Schema) -> list[Column]:
+    """Convert a PyArrow schema to a list of Unitycatalog Column objects."""
+    columns = []
+
+    for i, field in enumerate(schema):
+        data_type = field.type
+        json_type = pyarrow_to_uc_type(data_type)
+
+        column = Column(
+            name=field.name,
+            type_name=json_type,
+            nullable=field.nullable,
+            comment=f"Field {field.name}",  # Generic comment, modify as needed
+            position=i,
+            type_json=json.dumps(
+                {
+                    "name": field.name,
+                    "type": json_type,
+                    "nullable": field.nullable,
+                    "metadata": field.metadata or {},
+                }
+            ),
+            type_precision=0,
+            type_scale=0,
+            type_text=json_type,
+        )
+
+        # Adjust type precision and scale for decimal types
+        if pa.types.is_decimal(data_type):
+            column["type_precision"] = data_type.precision
+            column["type_scale"] = data_type.scale
+
+        columns.append(column)
+
+    return columns