schema-sentinel 3.0.0__tar.gz

schema_sentinel-3.0.0/.github/FUNDING.yml

@@ -0,0 +1,11 @@
+# These are supported funding model platforms
+
+github: [Igladyshev]
+# patreon: # your_patreon_username
+# open_collective: # your_open_collective_username
+# ko_fi: # your_ko_fi_username
+# tidelift: # your_tidelift_package_name
+# community_bridge: # your_community_bridge_project_name
+# liberapay: # your_liberapay_username
+# issuehunt: # your_issuehunt_username
+# custom: # your_custom_sponsorship_url

schema_sentinel-3.0.0/.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,89 @@
+name: Bug Report
+description: File a bug report to help us improve
+title: "[Bug]: "
+labels: ["bug", "needs-triage"]
+assignees: []
+
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to fill out this bug report! Please provide as much detail as possible.
+
+  - type: textarea
+    id: description
+    attributes:
+      label: Bug Description
+      description: A clear and concise description of what the bug is
+      placeholder: Tell us what you see!
+    validations:
+      required: true
+
+  - type: textarea
+    id: reproduction
+    attributes:
+      label: Steps to Reproduce
+      description: Steps to reproduce the behavior
+      placeholder: |
+        1. Configure connection to '...'
+        2. Run command '...'
+        3. See error
+    validations:
+      required: true
+
+  - type: textarea
+    id: expected
+    attributes:
+      label: Expected Behavior
+      description: What did you expect to happen?
+      placeholder: I expected to see...
+    validations:
+      required: true
+
+  - type: textarea
+    id: actual
+    attributes:
+      label: Actual Behavior
+      description: What actually happened? Include error messages and stack traces
+      placeholder: |
+        Error message:
+        ```
+        Paste error here
+        ```
+    validations:
+      required: true
+
+  - type: textarea
+    id: environment
+    attributes:
+      label: Environment
+      description: Please provide information about your environment
+      placeholder: |
+        - OS: [e.g. Ubuntu 22.04, Windows 11, macOS 13]
+        - Python version: [e.g. 3.9.10]
+        - schema-sentinel version: [e.g. 2.1.0]
+        - Database: [e.g. Snowflake 7.8.0]
+      value: |
+        - OS:
+        - Python version:
+        - schema-sentinel version:
+        - Database:
+    validations:
+      required: true
+
+  - type: textarea
+    id: additional
+    attributes:
+      label: Additional Context
+      description: Add any other context about the problem here
+      placeholder: Any additional information that might be helpful
+
+  - type: checkboxes
+    id: checklist
+    attributes:
+      label: Checklist
+      options:
+        - label: I have searched for similar issues before creating this one
+          required: true
+        - label: I have provided all requested information
+          required: true

schema_sentinel-3.0.0/.github/ISSUE_TEMPLATE/feature_request.yml

@@ -0,0 +1,76 @@
+name: Feature Request
+description: Suggest a new feature or enhancement
+title: "[Feature]: "
+labels: ["enhancement", "needs-triage"]
+assignees: []
+
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for suggesting a feature! Please describe your idea in detail.
+
+  - type: textarea
+    id: problem
+    attributes:
+      label: Problem Statement
+      description: Is your feature request related to a problem? Please describe.
+      placeholder: I'm always frustrated when...
+    validations:
+      required: true
+
+  - type: textarea
+    id: solution
+    attributes:
+      label: Proposed Solution
+      description: Describe the solution you'd like
+      placeholder: I would like to see...
+    validations:
+      required: true
+
+  - type: textarea
+    id: alternatives
+    attributes:
+      label: Alternatives Considered
+      description: Describe alternatives you've considered
+      placeholder: I also thought about...
+
+  - type: dropdown
+    id: database
+    attributes:
+      label: Database Support
+      description: Is this feature specific to a database?
+      options:
+        - All databases
+        - Snowflake
+        - PostgreSQL
+        - MySQL
+        - Oracle
+        - SQL Server
+        - Other
+    validations:
+      required: true
+
+  - type: textarea
+    id: use-case
+    attributes:
+      label: Use Case
+      description: Describe your use case and how this feature would help
+      placeholder: This would help me...
+    validations:
+      required: true
+
+  - type: textarea
+    id: additional
+    attributes:
+      label: Additional Context
+      description: Add any other context, screenshots, or examples
+      placeholder: Here's an example of how this might work...
+
+  - type: checkboxes
+    id: contribution
+    attributes:
+      label: Contribution
+      options:
+        - label: I would be willing to implement this feature
+        - label: I would be willing to help test this feature

schema_sentinel-3.0.0/.github/ISSUE_TEMPLATE/question.yml

@@ -0,0 +1,37 @@
+name: Question
+description: Ask a question about the project
+title: "[Question]: "
+labels: ["question"]
+assignees: []
+
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Have a question? We're here to help!
+
+  - type: textarea
+    id: question
+    attributes:
+      label: Your Question
+      description: What would you like to know?
+      placeholder: How do I...?
+    validations:
+      required: true
+
+  - type: textarea
+    id: context
+    attributes:
+      label: Context
+      description: Provide any relevant context or what you've already tried
+      placeholder: I tried...
+
+  - type: checkboxes
+    id: checklist
+    attributes:
+      label: Checklist
+      options:
+        - label: I have checked the documentation
+          required: true
+        - label: I have searched existing issues
+          required: true

schema_sentinel-3.0.0/.github/pull_request_template.md

@@ -0,0 +1,13 @@
+## What does this PR do?
+<!-- Brief description of your changes -->
+
+## Why?
+<!-- What problem does this solve? Link to issue if applicable -->
+
+Closes #
+
+## How to test?
+<!-- Quick steps to verify the changes work -->
+
+## Notes
+<!-- Anything reviewers should know? Breaking changes? Database affected? -->

schema_sentinel-3.0.0/.github/rulesets/README.md

@@ -0,0 +1,100 @@
+# GitHub Branch Rulesets
+
+This directory contains branch protection rules defined as JSON files that can be imported into GitHub.
+
+## Files
+
+- `master-branch-protection.json` - Protection rules for the master branch
+- `dev-branch-rules.json` - Rules for the dev branch
+
+## How to Apply These Rules
+
+### Method 1: Using GitHub Web Interface (Recommended)
+
+1. Go to your repository on GitHub
+2. Navigate to **Settings** → **Rules** → **Rulesets**
+3. Click **New ruleset** → **New branch ruleset**
+4. Click **Import a ruleset**
+5. Copy the content from the appropriate JSON file
+6. Paste it into the import dialog
+7. Review and save
+
+### Method 2: Using GitHub API
+
+You can also apply these rules using the GitHub REST API:
+
+```bash
+# Apply master branch protection
+curl -X POST \
+  -H "Authorization: token YOUR_TOKEN" \
+  -H "Accept: application/vnd.github+json" \
+  https://api.github.com/repos/OWNER/REPO/rulesets \
+  -d @master-branch-protection.json
+
+# Apply dev branch rules
+curl -X POST \
+  -H "Authorization: token YOUR_TOKEN" \
+  -H "Accept: application/vnd.github+json" \
+  https://api.github.com/repos/OWNER/REPO/rulesets \
+  -d @dev-branch-rules.json
+```
+
+## Rule Customization
+
+### Master Branch Protection
+
+The master branch has strict protection:
+- Requires 1 pull request approval
+- All CI status checks must pass
+- Prevents branch deletion
+- Prevents force pushes
+- Requires linear history
+
+### Dev Branch Rules
+
+The dev branch has lighter protection:
+- Requires only lint checks to pass
+- Prevents branch deletion
+- Allows direct pushes for rapid development
+
+### Modifying Rules
+
+To modify these rules:
+
+1. Edit the JSON file with your desired changes
+2. Re-import using Method 1 or 2 above
+3. Commit the changes to version control
+
+### Understanding Bypass Actors
+
+The `bypass_actors` section specifies who can bypass these rules:
+- `actor_id: 5` with `RepositoryRole` typically refers to repository administrators
+- `bypass_mode: always` means they can always bypass
+
+**Important**: The `actor_id: 5` is a common default for repository admin role, but this may vary depending on your specific repository configuration. When importing these rulesets:
+
+1. GitHub will automatically map the role if it exists
+2. If the role mapping fails, you can adjust it in the GitHub UI after import
+3. Alternatively, remove the `bypass_actors` section entirely if you want no bypasses
+
+To find the correct `actor_id` for your repository:
+- Navigate to Settings → Collaborators and teams
+- Use the GitHub API: `GET /repos/{owner}/{repo}/collaborators` to see role IDs
+- Or simply let GitHub handle the mapping during import
+
+## Common Rule Types
+
+Available rule types include:
+- `pull_request` - Require pull request reviews
+- `required_status_checks` - Require specific CI checks to pass
+- `deletion` - Prevent branch deletion
+- `non_fast_forward` - Prevent force pushes
+- `required_linear_history` - Require linear history
+- `required_signatures` - Require signed commits
+
+## Documentation
+
+For more information about the branching strategy, see [BRANCHING.md](../../BRANCHING.md) in the repository root.
+
+For GitHub Rulesets documentation, visit:
+https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/about-rulesets

schema_sentinel-3.0.0/.github/rulesets/dev-branch-rules.json

@@ -0,0 +1,37 @@
+{
+  "name": "Dev Branch Rules",
+  "target": "branch",
+  "enforcement": "active",
+  "conditions": {
+    "ref_name": {
+      "include": [
+        "refs/heads/dev"
+      ],
+      "exclude": []
+    }
+  },
+  "rules": [
+    {
+      "type": "required_status_checks",
+      "parameters": {
+        "strict_required_status_checks_policy": false,
+        "required_status_checks": [
+          {
+            "context": "Lint and Format Check",
+            "integration_id": null
+          }
+        ]
+      }
+    },
+    {
+      "type": "deletion"
+    }
+  ],
+  "bypass_actors": [
+    {
+      "actor_id": 5,
+      "actor_type": "RepositoryRole",
+      "bypass_mode": "always"
+    }
+  ]
+}

schema_sentinel-3.0.0/.github/rulesets/master-branch-protection.json

@@ -0,0 +1,61 @@
+{
+  "name": "Master Branch Protection",
+  "target": "branch",
+  "enforcement": "active",
+  "conditions": {
+    "ref_name": {
+      "include": [
+        "refs/heads/master"
+      ],
+      "exclude": []
+    }
+  },
+  "rules": [
+    {
+      "type": "pull_request",
+      "parameters": {
+        "required_approving_review_count": 1,
+        "dismiss_stale_reviews_on_push": true,
+        "require_code_owner_review": false,
+        "require_last_push_approval": false,
+        "required_review_thread_resolution": false
+      }
+    },
+    {
+      "type": "required_status_checks",
+      "parameters": {
+        "strict_required_status_checks_policy": true,
+        "required_status_checks": [
+          {
+            "context": "Test Python 3.13",
+            "integration_id": null
+          },
+          {
+            "context": "Lint and Format Check",
+            "integration_id": null
+          },
+          {
+            "context": "Type Checking",
+            "integration_id": null
+          }
+        ]
+      }
+    },
+    {
+      "type": "deletion"
+    },
+    {
+      "type": "non_fast_forward"
+    },
+    {
+      "type": "required_linear_history"
+    }
+  ],
+  "bypass_actors": [
+    {
+      "actor_id": 5,
+      "actor_type": "RepositoryRole",
+      "bypass_mode": "always"
+    }
+  ]
+}

schema_sentinel-3.0.0/.github/workflows/ci.yml

@@ -0,0 +1,106 @@
+name: CI
+
+on:
+  push:
+    branches: [ master, dev ]
+  pull_request:
+    branches: [ master, dev ]
+
+jobs:
+  test:
+    name: Test Python ${{ matrix.python-version }}
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.13"]
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Install uv
+      uses: astral-sh/setup-uv@v5
+      with:
+        version: "latest"
+
+    - name: Set up Python ${{ matrix.python-version }}
+      run: uv python install ${{ matrix.python-version }}
+
+    - name: Create virtual environment
+      run: uv venv
+
+    - name: Install dependencies
+      run: |
+        uv pip install -e ".[dev]"
+
+    - name: Run tests
+      run: |
+        source .venv/bin/activate
+        pytest --cov=schema_sentinel --cov-report=xml --cov-report=term-missing
+
+    - name: Upload coverage to Codecov
+      uses: codecov/codecov-action@v4
+      with:
+        file: ./coverage.xml
+        flags: unittests
+        name: codecov-umbrella
+        fail_ci_if_error: false
+
+  lint:
+    name: Lint and Format Check
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Install uv
+      uses: astral-sh/setup-uv@v5
+      with:
+        version: "latest"
+
+    - name: Set up Python
+      run: uv python install 3.13
+
+    - name: Create virtual environment
+      run: uv venv
+
+    - name: Install dependencies
+      run: |
+        uv pip install -e ".[dev]"
+
+    - name: Check code formatting with Ruff
+      run: |
+        source .venv/bin/activate
+        ruff format --check .
+
+    - name: Lint with Ruff
+      run: |
+        source .venv/bin/activate
+        ruff check .
+
+  type-check:
+    name: Type Checking
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Install uv
+      uses: astral-sh/setup-uv@v5
+      with:
+        version: "latest"
+
+    - name: Set up Python
+      run: uv python install 3.13
+
+    - name: Create virtual environment
+      run: uv venv
+
+    - name: Install dependencies
+      run: |
+        uv pip install -e ".[dev]"
+
+    - name: Type check with mypy
+      run: |
+        source .venv/bin/activate
+        mypy schema_sentinel/ --ignore-missing-imports
+      continue-on-error: true

schema_sentinel-3.0.0/.github/workflows/docs.yml

@@ -0,0 +1,62 @@
+name: Documentation
+
+on:
+  push:
+    branches: [ master ]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.13'
+
+      - name: Install uv
+        run: |
+          curl -LsSf https://astral.sh/uv/install.sh | sh
+          echo "$HOME/.local/bin" >> $GITHUB_PATH
+
+      - name: Install dependencies
+        run: |
+          uv venv
+          source .venv/bin/activate
+          uv pip install -e ".[dev]"
+
+      - name: Generate documentation
+        run: |
+          source .venv/bin/activate
+          pdoc schema_sentinel -o docs
+
+      - name: Setup Pages
+        uses: actions/configure-pages@v4
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: ./docs
+
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

schema_sentinel-3.0.0/.github/workflows/publish.yml

@@ -0,0 +1,47 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.13'
+
+      - name: Install build dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install build twine
+
+      - name: Build package
+        run: python -m build
+
+      - name: Upload artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  publish:
+    needs: build
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write  # Required for trusted publishing
+    steps:
+      - name: Download artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        # Uses trusted publishing - configure at pypi.org