multidimensional-evaluation-engine 0.1.0__tar.gz

multidimensional_evaluation_engine-0.1.0/.editorconfig

@@ -0,0 +1,117 @@
+# ============================================================
+# .editorconfig (Keep files consistent across editors and IDEs)
+# ============================================================
+# REQ.UNIVERSAL: All professional GitHub project repositories MUST include .editorconfig.
+# WHY: Establish a cross-editor baseline so diffs stay clean and formatting is consistent.
+# ALT: Repository may omit .editorconfig ONLY if formatting is enforced equivalently by CI and formatter tooling.
+# CUSTOM: Adjust indent_size defaults only if organizational standards change; keep stable across projects.
+# NOTE: Sections are ordered by editorial importance, not strict alphabetical order.
+# EditorConfig is documented at https://editorconfig.org
+
+root = true
+
+
+# === Global defaults (always apply) ===
+
+[*]
+# WHY: Normalize line endings and encoding across Windows, macOS, and Linux.
+end_of_line = lf
+charset = utf-8
+
+# WHY: Newline at EOF avoids noisy diffs and tool warnings.
+insert_final_newline = true
+
+# WHY: Remove accidental whitespace noise in diffs.
+trim_trailing_whitespace = true
+
+# WHY: Default to 2 spaces for configs and markup; language-specific overrides follow.
+indent_style = space
+indent_size = 2
+
+
+# === Build systems (special rules) ===
+
+[Makefile]
+# WHY: Makefiles require tabs.
+indent_style = tab
+
+[*.mk]
+# WHY: Makefile includes require tabs.
+indent_style = tab
+
+
+# === Markup and documentation ===
+
+[*.md]
+# WHY: Keep Markdown clean; use explicit <br> for hard line breaks.
+indent_size = 2
+trim_trailing_whitespace = true
+
+[*.{tex,cls,sty}]
+# WHY: LaTeX convention is 2 spaces.
+indent_size = 2
+indent_style = space
+
+[*.xml]
+# WHY: XML convention is 2 spaces.
+indent_size = 2
+indent_style = space
+
+[*.{yml,yaml}]
+# WHY: YAML convention is 2 spaces.
+indent_size = 2
+indent_style = space
+
+
+# === Data and configuration ===
+
+[*.{json,jsonc,jsonl,ndjson}]
+# WHY: JSON tooling typically expects 2 spaces.
+indent_size = 2
+indent_style = space
+
+[*.toml]
+# WHY: TOML often follows 4-space indentation in many projects.
+indent_size = 4
+indent_style = space
+
+
+# === Programming languages ===
+
+[*.{js,ts}]
+# WHY: JS/TS ecosystem commonly uses 2 spaces.
+indent_size = 2
+indent_style = space
+
+[*.{py,pyi}]
+# WHY: Python convention is 4 spaces.
+indent_size = 4
+indent_style = space
+
+[*.ps1]
+# WHY: PowerShell convention is 4 spaces.
+indent_size = 4
+indent_style = space
+
+[*.{c,cpp,h,java,cs,go,rs}]
+# WHY: Many C-family and systems languages commonly use 4 spaces.
+indent_size = 4
+indent_style = space
+
+[*.{sh,bash}]
+# WHY: Shell script convention is 2 spaces.
+indent_size = 2
+indent_style = space
+
+
+# === Proof assistants and formal languages ===
+
+[*.lean]
+# WHY: Lean 4 convention is 2 spaces; matches Mathlib and stdlib style.
+indent_size = 2
+indent_style = space
+
+[*.{v,vo}]
+# WHY: Coq convention is 2 spaces.
+indent_size = 2
+indent_style = space

multidimensional_evaluation_engine-0.1.0/.gitattributes

@@ -0,0 +1,129 @@
+# ============================================================
+# .gitattributes (Keep files consistent across operating systems)
+# ============================================================
+# REQ.UNIVERSAL: All professional GitHub project repositories MUST include .gitattributes.
+# WHY: Ensure consistent line endings, diff behavior, and file classification
+# across Windows, macOS, and Linux environments.
+# ALT: Repository may omit .gitattributes ONLY if equivalent normalization is
+# enforced reliably by tooling and CI (rare and fragile).
+# CUSTOM: Update file-type rules only when introducing new languages,
+# binary artifacts, or documentation formats.
+# NOTE: Rules are ordered by impact and generality, not alphabetically.
+# Git attributes are documented at https://git-scm.com/docs/gitattributes
+
+# === Core defaults (always apply) ===
+
+# WHY: Auto-detect text files and normalize line endings to avoid cross-platform drift.
+* text=auto
+
+
+# === Programming languages and scripts ===
+
+# WHY: Python and shell scripts must use LF for CI/CD, Linux environments, and containers.
+*.py    text eol=lf
+*.sh    text eol=lf
+
+# WHY: PowerShell convention on Windows uses CRLF.
+*.ps1   text eol=crlf
+
+
+# === Markup and documentation ===
+
+# WHY: Documentation and markup files use LF; standard for cross-platform tooling.
+*.md    text eol=lf
+*.tex   text eol=lf
+*.sty   text eol=lf
+*.cls   text eol=lf
+*.bib   text eol=lf
+
+
+# === Configuration and structured text ===
+
+# WHY: Configuration and structured text formats use LF for stable diffs.
+*.json     text eol=lf
+*.jsonc   text eol=lf
+*.jsonl   text eol=lf
+*.ndjson  text eol=lf
+*.toml    text eol=lf
+*.yaml    text eol=lf
+*.yml     text eol=lf
+
+
+# === Proof assistants and formal languages ===
+
+# WHY: Lean source files must use LF for cross-platform consistency and CI.
+*.lean   text eol=lf
+
+# WHY: Lean build artifacts are binary; prevent normalization and meaningless diffs.
+*.olean  binary
+*.ilean  binary
+*.trace  binary
+
+# WHY: Coq source uses LF; compiled objects are binary.
+*.v      text eol=lf
+*.vo     binary
+*.vok    binary
+*.vos    binary
+*.glob   binary
+
+# WHY: Lake build directory should be excluded, but if tracked, treat as binary.
+.lake/**  binary
+
+
+# === Notebooks ===
+
+# WHY: Jupyter notebooks require specialized diff and merge handling.
+*.ipynb   diff=jupyternotebook
+*.ipynb   merge=jupyternotebook
+
+
+# === Databases (binary) ===
+
+# WHY: Database files are binary; prevent text normalization and meaningless diffs.
+*.db       binary
+*.duckdb   binary
+*.sqlite   binary
+*.sqlite3  binary
+
+
+# === Columnar and analytical data (binary) ===
+
+# WHY: Columnar and analytical data formats are binary; diffs are not meaningful.
+*.arrow    binary
+*.avro     binary
+*.feather  binary
+*.orc      binary
+*.parquet  binary
+
+
+# === Office, BI, PDFs, and compressed artifacts (binary) ===
+
+# WHY: Office documents, BI files, PDFs, and compressed artifacts are binary.
+*.7z     binary
+*.bz2    binary
+*.docx   binary
+*.gz     binary
+*.pbix   binary
+*.pbit   binary
+*.pdf    binary
+*.pptx   binary
+*.rar    binary
+*.tar    binary
+*.tgz    binary
+*.xls    binary
+*.xlsm   binary
+*.xlsx   binary
+*.xz     binary
+*.zip    binary
+
+
+# === GitHub metadata and UI ===
+
+# WHY: Exclude documentation and tests from GitHub language statistics.
+docs/**    linguist-documentation
+tests/**   linguist-documentation
+
+# === LOG FILES ===
+# WHY: Log files are typically large and binary in nature; prevent text normalization.
+*.log binary
+project.log binary

multidimensional_evaluation_engine-0.1.0/.github/AGENTS.md

@@ -0,0 +1,51 @@
+# AI Instructions (AGENTS / CLAUDE / Copilot)
+
+## WHY
+
+- This repo uses a uniform, reproducible workflow based on **uv** and **pyproject.toml**.
+- These instructions exist to prevent tool drift (e.g., pip) and OS mismatch.
+
+## Requirements
+
+- Use **uv** for all environment, dependency, and run commands in this repo.
+- Do **not** recommend or use `pip install ...` as the primary workflow.
+- This repo targets **Python 3.14**, pinned via uv.
+- Commands and guidance must work on Windows, macOS, and Linux.
+- If shell-specific commands are unavoidable, provide both:
+  - PowerShell (Windows)
+  - bash/zsh (macOS/Linux)
+
+## Quickstart
+
+- Install **uv** using the official method for your OS.
+- Keep uv current.
+- Pin Python 3.14 for this project using uv.
+- Sync dependencies (dev + docs) and upgrade.
+
+```shell
+uv self update
+uv python pin 3.14
+uv sync --extra dev --extra docs --upgrade
+```
+
+## Common Tasks
+
+Run all commands via **uv**.
+
+Lint / format:
+
+```shell
+uv run ruff format .
+uv run ruff check .
+```
+
+Build documentation:
+
+```shell
+uv run zensical build
+```
+
+## pre-commit
+
+- pre-commit runs only on tracked / staged files.
+- Developers should `git add -A` files before expecting hooks to run.

multidimensional_evaluation_engine-0.1.0/.github/agents/Ask.agent.md

@@ -0,0 +1,40 @@
+---
+name: Ask
+description: Answers questions without making changes
+argument-hint: Ask a question about your code or project
+target: vscode
+disable-model-invocation: true
+tools: ['search', 'read', 'web', 'vscode/memory', 'execute/getTerminalOutput', 'execute/testFailure', 'vscode.mermaid-chat-features/renderMermaidDiagram', 'vscode/askQuestions']
+agents: []
+---
+You are an ASK AGENT — a knowledgeable assistant that answers questions, explains code, and provides information.
+
+Your job: understand the user's question → research the codebase as needed → provide a clear, thorough answer. You are strictly read-only: NEVER modify files or run commands that change state.
+
+<rules>
+- NEVER use file editing tools, terminal commands that modify state, or any write operations
+- Focus on answering questions, explaining concepts, and providing information
+- Use search and read tools to gather context from the codebase when needed
+- Provide code examples in your responses when helpful, but do NOT apply them
+- Use #tool:vscode/askQuestions to clarify ambiguous questions before researching
+- When the user's question is about code, reference specific files and symbols
+- If a question would require making changes, explain what changes would be needed but do NOT make them
+</rules>
+
+<capabilities>
+You can help with:
+- **Code explanation**: How does this code work? What does this function do?
+- **Architecture questions**: How is the project structured? How do components interact?
+- **Debugging guidance**: Why might this error occur? What could cause this behavior?
+- **Best practices**: What's the recommended approach for X? How should I structure Y?
+- **API and library questions**: How do I use this API? What does this method expect?
+- **Codebase navigation**: Where is X defined? Where is Y used?
+- **General programming**: Language features, algorithms, design patterns, etc.
+</capabilities>
+
+<workflow>
+1. **Understand** the question — identify what the user needs to know
+2. **Research** the codebase if needed — use search and read tools to find relevant code
+3. **Clarify** if the question is ambiguous — use #tool:vscode/askQuestions
+4. **Answer** clearly — provide a well-structured response with references to relevant code
+</workflow>

multidimensional_evaluation_engine-0.1.0/.github/copilot-instructions.md

@@ -0,0 +1,51 @@
+# AI Instructions (AGENTS / CLAUDE / Copilot)
+
+## WHY
+
+- This repo uses a uniform, reproducible workflow based on **uv** and **pyproject.toml**.
+- These instructions exist to prevent tool drift (e.g., pip) and OS mismatch.
+
+## Requirements
+
+- Use **uv** for all environment, dependency, and run commands in this repo.
+- Do **not** recommend or use `pip install ...` as the primary workflow.
+- This repo targets **Python 3.14**, pinned via uv.
+- Commands and guidance must work on Windows, macOS, and Linux.
+- If shell-specific commands are unavoidable, provide both:
+  - PowerShell (Windows)
+  - bash/zsh (macOS/Linux)
+
+## Quickstart
+
+- Install **uv** using the official method for your OS.
+- Keep uv current.
+- Pin Python 3.14 for this project using uv.
+- Sync dependencies (dev + docs) and upgrade.
+
+```shell
+uv self update
+uv python pin 3.14
+uv sync --extra dev --extra docs --upgrade
+```
+
+## Common Tasks
+
+Run all commands via **uv**.
+
+Lint / format:
+
+```shell
+uv run ruff format .
+uv run ruff check .
+```
+
+Build documentation:
+
+```shell
+uv run zensical build
+```
+
+## pre-commit
+
+- pre-commit runs only on tracked / staged files.
+- Developers should `git add -A` files before expecting hooks to run.

multidimensional_evaluation_engine-0.1.0/.github/dependabot.yml

@@ -0,0 +1,26 @@
+# ============================================================
+# .github/dependabot.yml (Check for GitHub Actions updates)
+# ============================================================
+# SOURCE: https://github.com/denisecase/templates
+#
+# REQ.PROJECT: This repository SHOULD track GitHub Actions updates automatically.
+# WHY-FILE: GitHub Actions are executable dependencies and may receive security or behavior updates.
+# OBS: Language-level dependencies (e.g., Python packages) are upgraded manually.
+# OBS: GitHub Actions are the only dependency class automated here.
+# ALT: Dependabot could be omitted if workflows are pinned and reviewed manually.
+# CUSTOM: Update interval if CI cadence or security posture changes.
+
+# NOTE: This file automatically updates the versions used in Actions workflows.
+# You don't need to modify this file.
+# To disable: Delete this file or set enabled: false below.
+# enabled: false # Uncomment to disable Dependabot
+
+version: 2 # Dependabot configuration version
+
+updates:
+  - package-ecosystem: "github-actions" # Dependency type
+    directory: "/" # Location of GitHub Actions workflows
+    schedule:
+      interval: "monthly" # ALT: Use "weekly" for higher security when needed
+    commit-message:
+      prefix: "(deps)"  # WHY: enable filtering by commit type

multidimensional_evaluation_engine-0.1.0/.github/workflows/ci-python-zensical.yml

@@ -0,0 +1,117 @@
+# ============================================================
+# .github/workflows/ci-python-zensical.yml (Continuous Integration)
+# ============================================================#
+# WHY-FILE: Validate repository hygiene, python, and documentation builds.
+# REQ: CI MUST NOT introduce arbitrary rules that are not reproducible locally.
+# OBS: CI validates only; it should not edit files or deploy docs.
+
+name: CI (Python + Zensical)
+
+# WHY: Validate code, docs, and repo metadata on PRs and pushes.
+# OBS: This workflow validates only; it never deploys.
+
+on:
+  push:
+    branches: [main] # WHY: Run when pushing to main branch.
+  pull_request:
+    branches: [main] # WHY: Run on pull requests targeting main branch.
+  workflow_dispatch: # WHY: Allow manual triggering from Actions tab.
+
+permissions: # WHY: Use least privileges required.
+  contents: read
+
+env:
+  PYTHONUNBUFFERED: "1" # WHY: Real-time logging.
+  PYTHONIOENCODING: "utf-8" # WHY: Ensure UTF-8 encoding for international characters.
+
+jobs:
+  ci:
+    name: Repository / Python checks and Zensical build
+    runs-on: ubuntu-latest # WHY: Linux environment matches most production deployments
+    timeout-minutes: 30 # WHY: Prevent hanging jobs. If over time, it is likely stuck.
+    env:
+      UV_PYTHON: "3.14" # WHY: Set Python version for all steps.
+
+    steps:
+      # ============================================================
+      # ASSEMBLE: Get code and set up environment
+      # ============================================================
+
+      - name: A1) Checkout repository code
+        # WHY: Needed to access files for checks.
+        uses: actions/checkout@v6
+
+      - name: A2) Install uv (with caching and uv.lock awareness)
+        uses: astral-sh/setup-uv@v7
+        with:
+          enable-cache: true # WHY: Speed up installs on subsequent runs
+          cache-dependency-glob: "uv.lock" # WHY: Only re-cache when dependencies change
+
+      - name: A3) Install Python 3.14 (no repo changes needed)
+        run: uv python install 3.14
+
+      - name: A4) Sync to install all dependencies
+        run: uv sync --extra dev --extra docs --upgrade
+
+      - name: A5) Show tool versions
+        run: |
+          uv --version
+          uv run python --version
+          if [ -f "zensical.toml" ]; then
+            uv run zensical --version
+          fi
+
+      - name: A6) Run pre-commit (all files)
+        run: uv tool run pre-commit run --all-files
+
+      # ============================================================
+      # === BASELINE CHECKS ===
+      # ============================================================
+
+      - name: B1) validate-pyproject (must be in pyproject.toml dependencies)
+        run: uv run validate-pyproject pyproject.toml
+
+      # ============================================================
+      # === COVERAGE AND TESTS: Verify functionality ===
+      # ============================================================
+
+      - name: C1) Run pytest with coverage
+        run: |
+          if [ -d "tests" ] && [ -n "$(find tests -type f \( -name 'test_*.py' -o -name '*_test.py' \) -print -quit)" ]; then
+            uv run pytest --verbose --cov=src --cov-report=term-missing --cov-report=xml
+          else
+            echo "## No Tests Found" >> "$GITHUB_STEP_SUMMARY"
+            echo "Tests directory missing or empty. CI continues." >> "$GITHUB_STEP_SUMMARY"
+          fi
+
+      - name: C2) Upload test coverage to GitHub Summary
+        if: always()
+        run: |
+          echo "## Test Coverage Report" >> "$GITHUB_STEP_SUMMARY"
+          if [ -f ".coverage" ]; then
+            echo '```' >> "$GITHUB_STEP_SUMMARY"
+            uv run coverage report >> "$GITHUB_STEP_SUMMARY"
+            echo '```' >> "$GITHUB_STEP_SUMMARY"
+          else
+            echo "No coverage data available." >> "$GITHUB_STEP_SUMMARY"
+          fi
+
+      - name: C3) Upload coverage artifact
+        if: always() && hashFiles('coverage.xml') != ''
+        uses: actions/upload-artifact@v7
+        with:
+          name: coverage-report
+          path: coverage.xml
+          retention-days: 30
+
+      # ============================================================
+      # === DEPLOY: Build only, don't deploy yet ===
+      # ============================================================
+
+      - name: D1) Build docs with Zensical
+        run: |
+          if [ -f "zensical.toml" ]; then
+            uv run zensical build
+          else
+            echo "No zensical.toml config found; skipping docs build."
+          fi

multidimensional_evaluation_engine-0.1.0/.github/workflows/deploy-zensical.yml

@@ -0,0 +1,105 @@
+# ============================================================
+# .github/workflows/deploy-zensical.yml (Deploy Docs)
+# ============================================================#
+# WHY-FILE: Build and deploy documentation to GitHub Pages on pushes to main.
+# REQ: Repo Settings -> Pages -> Build and deployment -> Source:
+#      GitHub Actions
+
+name: Docs Deploy (Zensical)
+
+on:
+  push:
+    branches: [main] # WHY: Run when pushing to main branch.
+  workflow_dispatch: # WHY: Allow manual triggering from Actions tab.
+
+permissions:
+  contents: read # WHY: Needed to checkout code.
+  pages: write # WHY: Required to deploy to GitHub Pages.
+  id-token: write # WHY: Required by deploy-pages for OIDC.
+
+env:
+  PYTHONUNBUFFERED: "1" # WHY: Real-time logging.
+  PYTHONIOENCODING: "utf-8" # WHY: Ensure UTF-8 encoding for international characters.
+
+concurrency:
+  # WHY: Only one Pages deployment at a time per branch.
+  group: pages-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  docs:
+    name: Deploy Documentation site
+    runs-on: ubuntu-latest
+    timeout-minutes: 30 # WHY: Prevent hanging jobs. If over, it is likely stuck.
+    env:
+      UV_PYTHON: "3.14" # WHY: Set Python version for all steps.
+
+    steps:
+      # ============================================================
+      # ASSEMBLE: Get code and set up environment
+      # ============================================================
+
+      - name: A1) Checkout repository code
+        # WHY: Needed to access files for checks.
+        uses: actions/checkout@v6
+
+      - name: A2) Configure GitHub Pages
+        # WHY: Sets Pages metadata for deployments.
+        uses: actions/configure-pages@v6
+
+      - name: A3) Install uv (with caching and uv.lock awareness)
+        uses: astral-sh/setup-uv@v7
+        with:
+          enable-cache: true # WHY: Speed up installs on subsequent runs
+          cache-dependency-glob: "uv.lock" # WHY: Only re-cache when dependencies change
+
+      - name: A4) Install Python 3.14 (no repo changes needed)
+        run: uv python install 3.14
+
+      - name: A5) Sync to install all dependencies
+        run: uv sync --extra dev --extra docs --upgrade
+
+      - name: A6) Show tool versions
+        run: |
+          uv --version
+          uv run python --version
+          if [ -f "zensical.toml" ]; then
+            uv run zensical --version
+          fi
+
+      # ============================================================
+      # === DEPLOY: Build and deploy ===
+      # ============================================================
+
+      - name: D1) Build docs with Zensical
+        run: |
+          if [ ! -f "zensical.toml" ]; then
+            echo "zensical.toml not found; refusing to deploy." >> "$GITHUB_STEP_SUMMARY"
+            exit 1
+          fi
+          uv run zensical build
+
+      - name: D2) Verify site output exists
+        # WHY: Zensical should create a static site in the configured output directory
+        # (commonly "site/"). If the directory does not exist, the documentation
+        # build likely failed or the configuration is incorrect.
+        run: |
+          if [ ! -d "site" ]; then
+            echo "## Documentation build output missing" >> "$GITHUB_STEP_SUMMARY"
+            echo "Expected directory 'site/' was not created." >> "$GITHUB_STEP_SUMMARY"
+            echo "Check the Zensical build step and zensical.toml configuration." >> "$GITHUB_STEP_SUMMARY"
+            exit 1
+          fi
+
+      - name: D3) Upload Pages artifact
+        # WHY: GitHub Pages deployments require a packaged artifact containing
+        # the built static site. This step bundles the contents of the site/
+        # directory so the next step can publish it.
+        uses: actions/upload-pages-artifact@v4
+        with:
+          path: site # WHY: Default Zensical output directory for the built site.
+
+      - name: D4) Deploy to GitHub Pages
+        # WHY: This step takes the uploaded artifact and publishes it to
+        # GitHub Pages so the documentation becomes publicly accessible.
+        uses: actions/deploy-pages@v5