coop-sql-review 0.1.0__tar.gz

coop_sql_review-0.1.0/.gitignore

@@ -0,0 +1,8 @@
+__pycache__/
+*.pyc
+.venv/
+.pytest_cache/
+.ruff_cache/
+dist/
+build/
+*.egg-info/

coop_sql_review-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Aaron Jennings
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

coop_sql_review-0.1.0/PKG-INFO

@@ -0,0 +1,244 @@
+Metadata-Version: 2.4
+Name: coop-sql-review
+Version: 0.1.0
+Summary: Offline, advisory SQL standards linter for Microsoft Fabric Data Warehouse: parses .sql files and reports anything that doesn't match the team's SQL standards. Human report + machine JSON for the company agent. Never edits or blocks.
+Project-URL: Homepage, https://github.com/kabukisensei/coop-sql-review
+Author: Aaron Jennings
+License: MIT
+License-File: LICENSE
+Keywords: data-warehouse,fabric,linter,sql,standards,tsql
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Database
+Classifier: Topic :: Software Development :: Quality Assurance
+Requires-Python: >=3.10
+Requires-Dist: click>=8.1
+Requires-Dist: pydantic>=2.5
+Requires-Dist: pyyaml>=6.0
+Requires-Dist: sqlglot>=25.0
+Provides-Extra: dev
+Requires-Dist: pytest>=8.0; extra == 'dev'
+Requires-Dist: ruff>=0.5; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# coop-sql-review
+
+A friendly tool that **reads your `.sql` files and points out anything that doesn't follow our
+SQL standards** for the Fabric data warehouse. It is **advisory only** — it never changes,
+rejects, or deletes anything. It just prints a report so you can fix things before committing.
+
+It works completely **offline** (your SQL never leaves your machine) and runs the same on
+**Windows and Mac**.
+
+---
+
+## 1. What you need first
+
+- **Python 3.10 or newer.** To check what you have, open a terminal (see below) and type:
+  ```
+  python --version
+  ```
+  If that says 3.10 or higher, you're set. If it says "command not found" or an older version,
+  install Python from https://www.python.org/downloads/ (tick *"Add Python to PATH"* on Windows).
+
+- **How to open a terminal:**
+  - **Windows:** press the Start button, type `Terminal`, press Enter.
+  - **Mac:** press `Cmd+Space`, type `Terminal`, press Enter.
+
+You'll type commands at the blinking prompt and press Enter after each one.
+
+---
+
+## 2. Install it (one time)
+
+We use **pipx**, which keeps the tool tidy and separate from everything else on your machine.
+
+**Step 1 — install pipx** (skip if you already have it):
+```
+python -m pip install --user pipx
+python -m pipx ensurepath
+```
+**Close and reopen your terminal** after this (so it picks up the new command).
+
+**Step 2 — install coop-sql-review:**
+```
+pipx install coop-sql-review
+```
+
+**Check it worked:**
+```
+coop-sql-review --version
+```
+You should see a version number like `coop-sql-review, version 0.1.0`.
+
+> Not published to PyPI yet? Install straight from the repository instead:
+> ```
+> pipx install git+https://github.com/kabukisensei/coop-sql-review.git
+> ```
+
+---
+
+## 3. Use it
+
+The main command is **`check`**. Point it at a file or a folder of `.sql` files.
+
+**Check one file:**
+```
+coop-sql-review check path/to/my_query.sql
+```
+
+**Check a whole folder** (it looks in sub-folders too):
+```
+coop-sql-review check path/to/sql-folder
+```
+
+> **Tip (don't know the path?)** Type `coop-sql-review check ` (with a trailing space), then
+> **drag the file or folder from your file explorer onto the terminal window** — it pastes the
+> path for you. Then press Enter.
+
+That's it. The tool prints a report and **always finishes successfully** — it won't block you.
+
+---
+
+## 4. Reading the report
+
+A typical report looks like this:
+
+```
+silver/dim_customer.sql
+  ! silver/dim_customer.sql:12  [warning] SQL-NO-SELECT-STAR (§11)
+      SELECT * in production code — list the columns explicitly (§11).
+  x silver/dim_customer.sql:4   [error] SQL-NO-ALTER-COLUMN (§9)
+      ALTER COLUMN is not supported in Fabric DW — use the CTAS + RENAME workaround (§9).
+
+Checked 1 file(s): 1 error, 1 warning.
+Advisory only - nothing was changed or blocked.
+```
+
+- Each line shows **`file:line`**, a **severity**, the **rule** that fired, and the **§ section**
+  of the standards it comes from.
+- **Severities:**
+  - **error** — almost certainly broken in Fabric (e.g. `ALTER COLUMN`, which Fabric rejects).
+  - **warning** — against the standard; worth fixing.
+  - **info** — a style/nice-to-have suggestion.
+- **Diagnostics** (a separate section, if shown) are *processing* notes — e.g. "this statement
+  uses syntax we couldn't fully read." They tell you where the tool's checking may be incomplete,
+  so nothing fails silently.
+- **Agent review** — a few checks (like "is this MERGE the right choice?") need human/agent
+  judgment, so they're listed separately rather than flagged as pass/fail.
+
+**Show only the important stuff** (hide the info-level suggestions):
+```
+coop-sql-review check sql-folder --min-severity warning
+```
+
+---
+
+## 5. All the commands
+
+| Command | What it does |
+|---|---|
+| `coop-sql-review check [paths...]` | Check files/folders against the standards (the main command). |
+| `coop-sql-review rules` | List every rule it checks, with severity and tier. |
+| `coop-sql-review help` | Show help. `help check` shows help for one command. |
+| `coop-sql-review update` | Update the tool to the newest version (same as `upgrade`). |
+| `coop-sql-review upgrade` | Update the tool to the newest version. |
+| `coop-sql-review --version` | Show the installed version. |
+
+### Options for `check`
+
+| Option | Meaning |
+|---|---|
+| `--min-severity error\|warning\|info` | Hide findings below this level. Default `info` (show all). |
+| `--format text\|json` | `text` (default) for humans, `json` for tools/the agent. |
+| `--standards <file>` | Check against a specific standards file (default: the built-in copy). |
+| `--config <rules.yml>` | Turn rules on/off or change their severity (see §7). |
+| `--log-file <file>` | Also write the diagnostics (parse problems, errors) to a file. |
+| `--strict` | Exit with an error code if any finding **at or above `--min-severity`** remains — for CI gates (see §6). |
+| `--dialect <name>` | SQL dialect to parse (default `tsql`, which fits Fabric). |
+
+Run `coop-sql-review rules` any time to see the current full list of checks.
+
+---
+
+## 6. Use it in CI (optional)
+
+By default the tool **never fails a build** (it's advisory). If a team *wants* a gate, add
+`--strict` with a severity floor — it then exits with an error code when something at/above that
+level is found:
+
+```
+coop-sql-review check sql-folder --strict --min-severity warning
+```
+
+For a machine-readable report (e.g. to attach to a build or feed the company agent):
+```
+coop-sql-review check sql-folder --format json > sql-review.json
+```
+
+---
+
+## 7. Customising the rules (optional)
+
+Create a small `rules.yml` to disable a rule or change its severity — no reinstall needed:
+
+```yaml
+rules:
+  SQL-DISTINCT-SMELL:
+    enabled: false          # turn this rule off
+  SQL-NO-SELECT-STAR:
+    severity: error         # treat SELECT * as an error instead of a warning
+```
+
+Then:
+```
+coop-sql-review check sql-folder --config rules.yml
+```
+
+To check against the team's canonical standards file directly:
+```
+coop-sql-review check sql-folder --standards path/to/sql-standards.md
+```
+
+---
+
+## 8. Keeping it up to date
+
+```
+coop-sql-review update
+```
+This updates the tool (and safe dependency updates) to the latest version. It's the only command
+that uses the internet.
+
+---
+
+## 9. Troubleshooting
+
+- **`coop-sql-review: command not found`** — you likely skipped `pipx ensurepath`, or didn't
+  reopen the terminal. Run `python -m pipx ensurepath`, then close and reopen the terminal.
+- **`externally-managed-environment` error on install** — that's why we use **pipx** (above)
+  instead of plain `pip`. Use the pipx steps in §2.
+- **It conflicts with another tool's packages** — pipx isolates coop-sql-review so this shouldn't
+  happen; if you installed with plain `pip`, uninstall and reinstall with pipx.
+- **Windows: odd characters in the report** — the tool prints UTF-8 and is tested on Windows; if
+  your console looks garbled, use Windows Terminal (the default on Windows 11).
+- **"No .sql files found"** — double-check the folder path; the tool only reads files ending in
+  `.sql`.
+
+---
+
+## For developers & AI agents
+
+- Architecture, the rule engine, and how to add a rule: see **`CLAUDE.md`**.
+- What to build and why: **`SPEC.md`**; the full rule taxonomy: **`RULES.md`**.
+- The standards being enforced: **`docs/standards.md`** (bundled with the tool).
+- Run the tests: `PYTHONPATH=src python -m pytest -q` · lint: `ruff check src tests`.
+
+This tool reuses the proven skeleton and conventions from the company's `coop-data-doc` tool
+and shared CLI playbook.

coop_sql_review-0.1.0/README.md

@@ -0,0 +1,215 @@
+# coop-sql-review
+
+A friendly tool that **reads your `.sql` files and points out anything that doesn't follow our
+SQL standards** for the Fabric data warehouse. It is **advisory only** — it never changes,
+rejects, or deletes anything. It just prints a report so you can fix things before committing.
+
+It works completely **offline** (your SQL never leaves your machine) and runs the same on
+**Windows and Mac**.
+
+---
+
+## 1. What you need first
+
+- **Python 3.10 or newer.** To check what you have, open a terminal (see below) and type:
+  ```
+  python --version
+  ```
+  If that says 3.10 or higher, you're set. If it says "command not found" or an older version,
+  install Python from https://www.python.org/downloads/ (tick *"Add Python to PATH"* on Windows).
+
+- **How to open a terminal:**
+  - **Windows:** press the Start button, type `Terminal`, press Enter.
+  - **Mac:** press `Cmd+Space`, type `Terminal`, press Enter.
+
+You'll type commands at the blinking prompt and press Enter after each one.
+
+---
+
+## 2. Install it (one time)
+
+We use **pipx**, which keeps the tool tidy and separate from everything else on your machine.
+
+**Step 1 — install pipx** (skip if you already have it):
+```
+python -m pip install --user pipx
+python -m pipx ensurepath
+```
+**Close and reopen your terminal** after this (so it picks up the new command).
+
+**Step 2 — install coop-sql-review:**
+```
+pipx install coop-sql-review
+```
+
+**Check it worked:**
+```
+coop-sql-review --version
+```
+You should see a version number like `coop-sql-review, version 0.1.0`.
+
+> Not published to PyPI yet? Install straight from the repository instead:
+> ```
+> pipx install git+https://github.com/kabukisensei/coop-sql-review.git
+> ```
+
+---
+
+## 3. Use it
+
+The main command is **`check`**. Point it at a file or a folder of `.sql` files.
+
+**Check one file:**
+```
+coop-sql-review check path/to/my_query.sql
+```
+
+**Check a whole folder** (it looks in sub-folders too):
+```
+coop-sql-review check path/to/sql-folder
+```
+
+> **Tip (don't know the path?)** Type `coop-sql-review check ` (with a trailing space), then
+> **drag the file or folder from your file explorer onto the terminal window** — it pastes the
+> path for you. Then press Enter.
+
+That's it. The tool prints a report and **always finishes successfully** — it won't block you.
+
+---
+
+## 4. Reading the report
+
+A typical report looks like this:
+
+```
+silver/dim_customer.sql
+  ! silver/dim_customer.sql:12  [warning] SQL-NO-SELECT-STAR (§11)
+      SELECT * in production code — list the columns explicitly (§11).
+  x silver/dim_customer.sql:4   [error] SQL-NO-ALTER-COLUMN (§9)
+      ALTER COLUMN is not supported in Fabric DW — use the CTAS + RENAME workaround (§9).
+
+Checked 1 file(s): 1 error, 1 warning.
+Advisory only - nothing was changed or blocked.
+```
+
+- Each line shows **`file:line`**, a **severity**, the **rule** that fired, and the **§ section**
+  of the standards it comes from.
+- **Severities:**
+  - **error** — almost certainly broken in Fabric (e.g. `ALTER COLUMN`, which Fabric rejects).
+  - **warning** — against the standard; worth fixing.
+  - **info** — a style/nice-to-have suggestion.
+- **Diagnostics** (a separate section, if shown) are *processing* notes — e.g. "this statement
+  uses syntax we couldn't fully read." They tell you where the tool's checking may be incomplete,
+  so nothing fails silently.
+- **Agent review** — a few checks (like "is this MERGE the right choice?") need human/agent
+  judgment, so they're listed separately rather than flagged as pass/fail.
+
+**Show only the important stuff** (hide the info-level suggestions):
+```
+coop-sql-review check sql-folder --min-severity warning
+```
+
+---
+
+## 5. All the commands
+
+| Command | What it does |
+|---|---|
+| `coop-sql-review check [paths...]` | Check files/folders against the standards (the main command). |
+| `coop-sql-review rules` | List every rule it checks, with severity and tier. |
+| `coop-sql-review help` | Show help. `help check` shows help for one command. |
+| `coop-sql-review update` | Update the tool to the newest version (same as `upgrade`). |
+| `coop-sql-review upgrade` | Update the tool to the newest version. |
+| `coop-sql-review --version` | Show the installed version. |
+
+### Options for `check`
+
+| Option | Meaning |
+|---|---|
+| `--min-severity error\|warning\|info` | Hide findings below this level. Default `info` (show all). |
+| `--format text\|json` | `text` (default) for humans, `json` for tools/the agent. |
+| `--standards <file>` | Check against a specific standards file (default: the built-in copy). |
+| `--config <rules.yml>` | Turn rules on/off or change their severity (see §7). |
+| `--log-file <file>` | Also write the diagnostics (parse problems, errors) to a file. |
+| `--strict` | Exit with an error code if any finding **at or above `--min-severity`** remains — for CI gates (see §6). |
+| `--dialect <name>` | SQL dialect to parse (default `tsql`, which fits Fabric). |
+
+Run `coop-sql-review rules` any time to see the current full list of checks.
+
+---
+
+## 6. Use it in CI (optional)
+
+By default the tool **never fails a build** (it's advisory). If a team *wants* a gate, add
+`--strict` with a severity floor — it then exits with an error code when something at/above that
+level is found:
+
+```
+coop-sql-review check sql-folder --strict --min-severity warning
+```
+
+For a machine-readable report (e.g. to attach to a build or feed the company agent):
+```
+coop-sql-review check sql-folder --format json > sql-review.json
+```
+
+---
+
+## 7. Customising the rules (optional)
+
+Create a small `rules.yml` to disable a rule or change its severity — no reinstall needed:
+
+```yaml
+rules:
+  SQL-DISTINCT-SMELL:
+    enabled: false          # turn this rule off
+  SQL-NO-SELECT-STAR:
+    severity: error         # treat SELECT * as an error instead of a warning
+```
+
+Then:
+```
+coop-sql-review check sql-folder --config rules.yml
+```
+
+To check against the team's canonical standards file directly:
+```
+coop-sql-review check sql-folder --standards path/to/sql-standards.md
+```
+
+---
+
+## 8. Keeping it up to date
+
+```
+coop-sql-review update
+```
+This updates the tool (and safe dependency updates) to the latest version. It's the only command
+that uses the internet.
+
+---
+
+## 9. Troubleshooting
+
+- **`coop-sql-review: command not found`** — you likely skipped `pipx ensurepath`, or didn't
+  reopen the terminal. Run `python -m pipx ensurepath`, then close and reopen the terminal.
+- **`externally-managed-environment` error on install** — that's why we use **pipx** (above)
+  instead of plain `pip`. Use the pipx steps in §2.
+- **It conflicts with another tool's packages** — pipx isolates coop-sql-review so this shouldn't
+  happen; if you installed with plain `pip`, uninstall and reinstall with pipx.
+- **Windows: odd characters in the report** — the tool prints UTF-8 and is tested on Windows; if
+  your console looks garbled, use Windows Terminal (the default on Windows 11).
+- **"No .sql files found"** — double-check the folder path; the tool only reads files ending in
+  `.sql`.
+
+---
+
+## For developers & AI agents
+
+- Architecture, the rule engine, and how to add a rule: see **`CLAUDE.md`**.
+- What to build and why: **`SPEC.md`**; the full rule taxonomy: **`RULES.md`**.
+- The standards being enforced: **`docs/standards.md`** (bundled with the tool).
+- Run the tests: `PYTHONPATH=src python -m pytest -q` · lint: `ruff check src tests`.
+
+This tool reuses the proven skeleton and conventions from the company's `coop-data-doc` tool
+and shared CLI playbook.

coop_sql_review-0.1.0/pyproject.toml

@@ -0,0 +1,54 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "coop-sql-review"
+version = "0.1.0"
+description = "Offline, advisory SQL standards linter for Microsoft Fabric Data Warehouse: parses .sql files and reports anything that doesn't match the team's SQL standards. Human report + machine JSON for the company agent. Never edits or blocks."
+readme = "README.md"
+requires-python = ">=3.10"
+license = { text = "MIT" }
+authors = [{ name = "Aaron Jennings" }]
+keywords = ["sql", "linter", "fabric", "data-warehouse", "tsql", "standards"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Environment :: Console",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Database",
+    "Topic :: Software Development :: Quality Assurance",
+]
+dependencies = [
+    "pydantic>=2.5",
+    "PyYAML>=6.0",
+    "sqlglot>=25.0",
+    "click>=8.1",
+]
+
+[project.optional-dependencies]
+dev = ["pytest>=8.0", "ruff>=0.5"]
+
+[project.scripts]
+coop-sql-review = "coop_sql_review.cli:main"
+
+[project.urls]
+Homepage = "https://github.com/kabukisensei/coop-sql-review"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/coop_sql_review"]
+
+[tool.hatch.build]
+# Ship the bundled standards so `coop-sql-review` works with no --standards flag.
+include = ["src/coop_sql_review/**/*.py", "src/coop_sql_review/data/*.md"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+
+[tool.ruff]
+line-length = 110
+target-version = "py310"

coop_sql_review-0.1.0/src/coop_sql_review/__init__.py

@@ -0,0 +1,3 @@
+"""coop-sql-review: offline, advisory SQL standards linter for Fabric DW."""
+
+__version__ = "0.1.0"

coop_sql_review-0.1.0/src/coop_sql_review/__main__.py

@@ -0,0 +1,4 @@
+from coop_sql_review.cli import main
+
+if __name__ == "__main__":
+    main()