Docs: Refresh Python SDK examples

Author: ayush-shah

.github/CODEOWNERS

@@ -0,0 +1 @@
+/sdk-examples/ @open-metadata/ingestion @open-metadata/documentation-team

.github/workflows/test-sdk-examples.yml

@@ -1,139 +1,55 @@
-name: Test SDK Examples
+name: Test Python SDK examples
 
 on:
-  pull_request:
-    paths:
-      - 'sdk-examples/**'
-      - '.github/workflows/test-sdk-examples.yml'
+  pull_request: {}
   push:
-    branches:
-      - main
-      - 'claude/**'
-    paths:
-      - 'sdk-examples/**'
-      - '.github/workflows/test-sdk-examples.yml'
+    branches: [main]
 
-jobs:
-  test:
-    name: Test SDK Examples (Python 3.10)
-    runs-on: ubuntu-latest
-    permissions:
-      contents: read
-      pull-requests: write
-
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v4
-        with:
-          fetch-depth: 0
-
-      - name: Set up Python 3.10
-        uses: actions/setup-python@v4
-        with:
-          python-version: '3.10'
-          cache: 'pip'
-
-      - name: Install dependencies
-        run: |
-          python -m pip install --upgrade pip setuptools wheel
-          pip install --prefer-binary -r sdk-examples/requirements-test.txt
-
-      - name: Run tests with pytest and coverage
-        working-directory: sdk-examples
-        run: |
-          pytest tests/ -v --cov=. --cov-report=term-missing --cov-report=xml --cov-report=html
-
-      - name: Verify coverage data exists
-        working-directory: sdk-examples
-        run: |
-          if [ ! -f .coverage ]; then
-            echo "Error: No coverage data found. Coverage was not collected."
-            exit 1
-          fi
-          echo "Coverage data verified at .coverage"
-
-      - name: Coverage comment
-        uses: py-cov-action/python-coverage-comment-action@v3
-        if: github.event_name == 'pull_request'
-        with:
-          GITHUB_TOKEN: ${{ github.token }}
-          MINIMUM_GREEN: 100
-          MINIMUM_ORANGE: 90
-          ANNOTATE_MISSING_LINES: true
-          ANNOTATION_TYPE: warning
-          COVERAGE_PATH: sdk-examples
+permissions:
+  contents: read
 
-      - name: Generate coverage report
-        if: always()
-        working-directory: sdk-examples
-        run: |
-          pip install coverage
-          coverage report --show-missing
-
-  lint:
-    name: Lint SDK Examples
+jobs:
+  python:
+    name: Python 3.12 / openmetadata-ingestion 1.13
     runs-on: ubuntu-latest
 
     steps:
-      - name: Checkout code
+      - name: Check out repository
         uses: actions/checkout@v4
 
-      - name: Set up Python
-        uses: actions/setup-python@v4
+      - name: Set up Python 3.12
+        uses: actions/setup-python@v5
         with:
-          python-version: '3.10'
+          python-version: "3.12"
+          cache: pip
+          cache-dependency-path: sdk-examples/requirements-test.txt
 
-      - name: Install linting tools
+      - name: Install pinned SDK and test tools
         run: |
           python -m pip install --upgrade pip
-          pip install ruff black isort
+          python -m pip install -r sdk-examples/requirements-test.txt
 
-      - name: Check formatting with black
-        run: |
-          black --check sdk-examples/*.py sdk-examples/tests/*.py || true
+      - name: Compile examples
+        run: python -m compileall -q sdk-examples
 
-      - name: Check import sorting with isort
-        run: |
-          isort --check-only sdk-examples/*.py sdk-examples/tests/*.py || true
+      - name: Test imports, requests, and mocked SDK calls
+        run: pytest -q sdk-examples/tests
 
-      - name: Lint with ruff
-        run: |
-          ruff check sdk-examples/*.py sdk-examples/tests/*.py || true
+      - name: Lint
+        run: ruff check sdk-examples
 
-  validate-examples:
-    name: Validate Example Files
+      - name: Check formatting
+        run: ruff format --check sdk-examples
+
+  secrets:
+    name: Secret scan
     runs-on: ubuntu-latest
 
     steps:
-      - name: Checkout code
+      - name: Check out repository
         uses: actions/checkout@v4
 
-      - name: Set up Python
-        uses: actions/setup-python@v4
+      - name: Scan for secrets
+        uses: docker://zricethezav/gitleaks:v8.27.0
         with:
-          python-version: '3.10'
-
-      - name: Install dependencies
-        run: |
-          python -m pip install --upgrade pip setuptools wheel
-          pip install --prefer-binary -r sdk-examples/requirements-test.txt
-
-      - name: Validate Python syntax
-        run: |
-          python -m py_compile sdk-examples/*.py
-          python -m py_compile sdk-examples/tests/*.py
-
-      - name: Check for common issues
-        run: |
-          # Check all files have proper docstrings (skip shebangs and encoding declarations)
-          for file in sdk-examples/*.py; do
-            if ! head -n 20 "$file" | grep -E '^("""|'"'"''"'"''"'"')' > /dev/null; then
-              echo "Missing docstring in $file"
-              exit 1
-            fi
-          done
-
-      - name: Verify all imports can be resolved
-        working-directory: sdk-examples
-        run: |
-          python -c "import setup; import services; import entities; import metadata_ops; import lineage; import queries; import advanced"
+          args: dir /github/workspace --redact --no-banner

README.md

@@ -1,3 +1,44 @@
-# OpenMetadata Demo
+# OpenMetadata examples
 
-In this repo you can find resources to try out OpenMetadata with different connectors.
+Runnable examples for OpenMetadata and Collate.
+
+## Supported Python SDK examples
+
+[`sdk-examples`](./sdk-examples) is maintained and tested against:
+
+- OpenMetadata server: `1.13.x`
+- Python package: `openmetadata-ingestion~=1.13.0`
+- Public API: `metadata.sdk`
+- Python: `3.12`
+
+Install and run the table CRUD example:
+
+```bash
+python -m venv .venv
+source .venv/bin/activate
+python -m pip install "openmetadata-ingestion~=1.13.0"
+
+export OPENMETADATA_HOST="http://localhost:8585/api"
+export OPENMETADATA_JWT_TOKEN="<jwt-token>"
+python sdk-examples/02_basic_crud.py
+```
+
+The example expects the sample schema `sample_data.ecommerce_db.shopify`. Override
+`DEFAULT_SCHEMA_FQN` in the script when using another schema.
+
+Documentation:
+
+- [OpenMetadata Python SDK](https://docs.open-metadata.org/latest/api-reference/sdk/python)
+- [Collate Python SDK](https://docs.getcollate.io/sdk/python)
+
+## Support status
+
+| Path | Status |
+| --- | --- |
+| `sdk-examples/` | Maintained. Python checks block pull requests. |
+| `sdk-2.0-examples/java/` | Reference only. Not covered by Python SDK CI. |
+| Other demo folders | Reference or integration-specific. Check the folder README and pinned dependencies before use. |
+
+Python SDK maintainers: `@open-metadata/ingestion`
+
+Documentation maintainers: `@open-metadata/documentation-team`

custom-connector/custom.yaml

@@ -21,4 +21,4 @@ workflowConfig:
     hostPort: http://localhost:8585/api
     authProvider: openmetadata
     securityConfig:
-      jwtToken: "eyJraWQiOiJHYjM4OWEtOWY3Ni1nZGpzLWE5MmotMDI0MmJrOTQzNTYiLCJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJhZG1pbiIsImlzQm90IjpmYWxzZSwiaXNzIjoib3Blbi1tZXRhZGF0YS5vcmciLCJpYXQiOjE2NjM5Mzg0NjIsImVtYWlsIjoiYWRtaW5Ab3Blbm1ldGFkYXRhLm9yZyJ9.tS8um_5DKu7HgzGBzS1VTA5uUjKWOCU0B_j08WXBiEC0mr0zNREkqVfwFDD-d24HlNEbrqioLsBuFRiwIWKc1m_ZlVQbG7P36RUxhuv2vbSp80FKyNM-Tj93FDzq91jsyNmsQhyNv_fNr3TXfzzSPjHt8Go0FMMP66weoKMgW2PbXlhVKwEuXUHyakLLzewm9UMeQaEiRzhiTMU3UkLXcKbYEJJvfNFcLwSl9W8JCO_l0Yj3ud-qt_nQYEZwqW6u5nfdQllN133iikV4fM5QZsMCnm8Rq1mvLR0y9bmJiD7fwM1tmJ791TUWqmKaTnP49U493VanKpUAfzIiOiIbhg"
+      jwtToken: "<jwt-token>"

custom-connector/custom_proto.yaml

@@ -22,4 +22,4 @@ workflowConfig:
     hostPort: http://localhost:8585/api
     authProvider: openmetadata
     securityConfig:
-      jwtToken: "eyJraWQiOiJHYjM4OWEtOWY3Ni1nZGpzLWE5MmotMDI0MmJrOTQzNTYiLCJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJhZG1pbiIsImlzQm90IjpmYWxzZSwiaXNzIjoib3Blbi1tZXRhZGF0YS5vcmciLCJpYXQiOjE2NjM5Mzg0NjIsImVtYWlsIjoiYWRtaW5Ab3Blbm1ldGFkYXRhLm9yZyJ9.tS8um_5DKu7HgzGBzS1VTA5uUjKWOCU0B_j08WXBiEC0mr0zNREkqVfwFDD-d24HlNEbrqioLsBuFRiwIWKc1m_ZlVQbG7P36RUxhuv2vbSp80FKyNM-Tj93FDzq91jsyNmsQhyNv_fNr3TXfzzSPjHt8Go0FMMP66weoKMgW2PbXlhVKwEuXUHyakLLzewm9UMeQaEiRzhiTMU3UkLXcKbYEJJvfNFcLwSl9W8JCO_l0Yj3ud-qt_nQYEZwqW6u5nfdQllN133iikV4fM5QZsMCnm8Rq1mvLR0y9bmJiD7fwM1tmJ791TUWqmKaTnP49U493VanKpUAfzIiOiIbhg"
+      jwtToken: "<jwt-token>"

custom-graphql/README.md

@@ -75,7 +75,7 @@ workflowConfig:
     hostPort: "http://localhost:8585/api"
     authProvider: "openmetadata"
     securityConfig:
-      jwtToken: "eyJraWQiOiJHYjM4OWE
+      jwtToken: "<jwt-token>"
 ```
 
 **Important Configuration Notes:**

custom-graphql/user_updater.yaml

@@ -19,4 +19,4 @@ workflowConfig:
     hostPort: "http://localhost:8585/api"
     authProvider: "openmetadata"
     securityConfig:
-      jwtToken: "eyJraWQiOiJHYjM4OWEtOWY3Ni1nZGpzLWE5MmotMDI0MmJrOTQzNTYiLCJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJhZG1pbiIsImlzQm90IjpmYWxzZSwiaXNzIjoib3Blbi1tZXRhZGF0YS5vcmciLCJpYXQiOjE2NjM5Mzg0NjIsImVtYWlsIjoiYWRtaW5Ab3Blbm1ldGFkYXRhLm9yZyJ9.tS8um_5DKu7HgzGBzS1VTA5uUjKWOCU0B_j08WXBiEC0mr0zNREkqVfwFDD-d24HlNEbrqioLsBuFRiwIWKc1m_ZlVQbG7P36RUxhuv2vbSp80FKyNM-Tj93FDzq91jsyNmsQhyNv_fNr3TXfzzSPjHt8Go0FMMP66weoKMgW2PbXlhVKwEuXUHyakLLzewm9UMeQaEiRzhiTMU3UkLXcKbYEJJvfNFcLwSl9W8JCO_l0Yj3ud-qt_nQYEZwqW6u5nfdQllN133iikV4fM5QZsMCnm8Rq1mvLR0y9bmJiD7fwM1tmJ791TUWqmKaTnP49U493VanKpUAfzIiOiIbhg"
+      jwtToken: "<jwt-token>"

dynamic_csv_importer/csv_importer.py

@@ -303,7 +303,7 @@ class DebugArgs:
             csv_path = "sample_dbt_jaffle.csv"
             entities = "all"  # or "Table" or "DashboardDataModel"
             url = "http://localhost:8585/api"
-            jwt_token = "eyJraWQiOiJHYjM4OWEtOWY3Ni1nZGpzLWE5MmotMDI0MmJrOTQzNTYiLCJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJhZG1pbiIsImlzQm90IjpmYWxzZSwiaXNzIjoib3Blbi1tZXRhZGF0YS5vcmciLCJpYXQiOjE2NjM5Mzg0NjIsImVtYWlsIjoiYWRtaW5Ab3Blbm1ldGFkYXRhLm9yZyJ9.tS8um_5DKu7HgzGBzS1VTA5uUjKWOCU0B_j08WXBiEC0mr0zNREkqVfwFDD-d24HlNEbrqioLsBuFRiwIWKc1m_ZlVQbG7P36RUxhuv2vbSp80FKyNM-Tj93FDzq91jsyNmsQhyNv_fNr3TXfzzSPjHt8Go0FMMP66weoKMgW2PbXlhVKwEuXUHyakLLzewm9UMeQaEiRzhiTMU3UkLXcKbYEJJvfNFcLwSl9W8JCO_l0Yj3ud-qt_nQYEZwqW6u5nfdQllN133iikV4fM5QZsMCnm8Rq1mvLR0y9bmJiD7fwM1tmJ791TUWqmKaTnP49U493VanKpUAfzIiOiIbhg"
+            jwt_token = "<jwt-token>"
             report_only = True  # Set to False to actually update entities
 
         args = DebugArgs()