matrx-orm 2.0.1__tar.gz → 2.0.2__tar.gz

matrx_orm-2.0.2/.env.example

@@ -0,0 +1,11 @@
+BASE_DIR=enter_your_base_directory_here
+ADMIN_PYTHON_ROOT=enter_your_python_root_directory_here
+ADMIN_TS_ROOT=enter_your_ts_root_directory_here
+
+SUPABASE_MATRX_URL=supabase_host_url
+DB_HOST=host
+DB_NAME=postgres
+DB_PORT=6543
+DB_USER=user
+DB_PASS=password
+SUPABASE_MATRX_JWT_SECRET=secret

{matrx_orm-2.0.1 → matrx_orm-2.0.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: matrx-orm
-Version: 2.0.1
+Version: 2.0.2
 Summary: Async-first PostgreSQL ORM with bidirectional migrations, schema introspection, many-to-many relationships, and built-in state caching. Works with any PostgreSQL database.
 Project-URL: Homepage, https://github.com/armanisadeghi/matrx-orm
 Project-URL: Repository, https://github.com/armanisadeghi/matrx-orm
@@ -1833,6 +1833,7 @@ When you run the schema builder against a database that has `vector(n)` columns,
 
 | Version | Highlights |
 |---|---|
+| **v2.0.2** | Patch release |
 | **v2.0.0** | pgvector support: `VectorField(dimensions=n)` with serialization/validation; `VectorDistance` expression; `.nearest(column, vector, metric)` query builder method; automatic null guard; `_vector_distance` in results; asyncpg codec auto-registered on pool init; `IndexDef` extended with `vector_ops` / `index_params` for HNSW & IVFFlat DDL; schema builder recognises `vector(n)` columns |
 | **v1.9.0** | Schema builder externalization: app-specific entity/field overrides removed from the ORM package and moved to `DatabaseProjectConfig` (`entity_overrides`, `field_overrides`); new `get_schema_builder_overrides()` accessor; `sql_executor/queries.py` reduced to generic TypedDicts + empty registry with a `register_query()` helper; all hardcoded project-name defaults removed from public APIs |
 | **v1.9.0** | Cross-schema & multi-database FK support: `ForeignKey(to_schema='auth')` for same-database cross-schema FKs (e.g. `auth.users`); `ForeignKey(to_db='other_project')` for cross-database routing; `ForeignKeyReference` gains `to_db`/`to_schema`; `_unfetchable` now emits a `UserWarning` instead of silently returning `None`; `Users` stub removes `_unfetchable = True` so `auth.users` fetches work out of the box; introspection SQL captures referenced schema via `pg_namespace`; schema builder emits `to_schema` in generated code; `DatabaseProjectConfig.additional_schemas` replaces hardcoded `["auth"]` everywhere |

{matrx_orm-2.0.1 → matrx_orm-2.0.2}/README.md

@@ -1795,6 +1795,7 @@ When you run the schema builder against a database that has `vector(n)` columns,
 
 | Version | Highlights |
 |---|---|
+| **v2.0.2** | Patch release |
 | **v2.0.0** | pgvector support: `VectorField(dimensions=n)` with serialization/validation; `VectorDistance` expression; `.nearest(column, vector, metric)` query builder method; automatic null guard; `_vector_distance` in results; asyncpg codec auto-registered on pool init; `IndexDef` extended with `vector_ops` / `index_params` for HNSW & IVFFlat DDL; schema builder recognises `vector(n)` columns |
 | **v1.9.0** | Schema builder externalization: app-specific entity/field overrides removed from the ORM package and moved to `DatabaseProjectConfig` (`entity_overrides`, `field_overrides`); new `get_schema_builder_overrides()` accessor; `sql_executor/queries.py` reduced to generic TypedDicts + empty registry with a `register_query()` helper; all hardcoded project-name defaults removed from public APIs |
 | **v1.9.0** | Cross-schema & multi-database FK support: `ForeignKey(to_schema='auth')` for same-database cross-schema FKs (e.g. `auth.users`); `ForeignKey(to_db='other_project')` for cross-database routing; `ForeignKeyReference` gains `to_db`/`to_schema`; `_unfetchable` now emits a `UserWarning` instead of silently returning `None`; `Users` stub removes `_unfetchable = True` so `auth.users` fetches work out of the box; introspection SQL captures referenced schema via `pg_namespace`; schema builder emits `to_schema` in generated code; `DatabaseProjectConfig.additional_schemas` replaces hardcoded `["auth"]` everywhere |

{matrx_orm-2.0.1 → matrx_orm-2.0.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "matrx-orm"
-version = "2.0.1"
+version = "2.0.2"
 description = "Async-first PostgreSQL ORM with bidirectional migrations, schema introspection, many-to-many relationships, and built-in state caching. Works with any PostgreSQL database."
 readme = "README.md"
 license = { text = "MIT" }

{matrx_orm-2.0.1 → matrx_orm-2.0.2}/src/matrx_orm/client/postgres_connection.py

@@ -21,6 +21,7 @@ def init_connection_details(config_name):
 
         db_host = config.get("host")
         db_port = config.get("port")
+        db_protocol = config.get("protocol", "postgresql")
         db_name = config.get("database_name")
         db_user = config.get("user")
         db_password = config.get("password")
@@ -29,9 +30,9 @@ def init_connection_details(config_name):
             raise ValueError(
                 f"Incomplete database configuration for '{config_name}'. " "Please check your environment variables or settings.")
 
-        connection_string = f"postgresql://{db_user}:{db_password}@{db_host}:{db_port}/{db_name}"
+        connection_string = f"{db_protocol}://{db_user}:{db_password}@{db_host}:{db_port}/{db_name}"
 
-        vcprint(f"\n[Matrx ORM] Connection String:\n{connection_string}\n", color="green")
+        vcprint(f"\n[Matrx ORM] Connection String:\n{connection_string}\n", color="yellow")
 
         connection_pools[config_name] = ConnectionPool(
             connection_string,

{matrx_orm-2.0.1 → matrx_orm-2.0.2}/src/matrx_orm/core/config.py

@@ -17,6 +17,7 @@ class DatabaseProjectConfig:
     user: str
     password: str
 
+    protocol: str = "postgresql"
     alias: str = ""
     manager_config_overrides: Dict = field(default_factory=dict)
 
@@ -69,6 +70,7 @@ class DatabaseRegistry:
         if not all(required_fields):
             missing = []
             if not config.host: missing.append("host")
+            if not config.protocol: missing.append("protocol")
             if not config.alias: missing.append("alias")
             if not config.port: missing.append("port")
             if not config.database_name: missing.append("database_name")
@@ -87,6 +89,7 @@ class DatabaseRegistry:
         return {
             "host": config.host,
             "port": config.port,
+            "protocol": config.protocol,
             "database_name": config.database_name,
             "user": config.user,
             "password": config.password,
@@ -111,6 +114,7 @@ class DatabaseRegistry:
             all_configs[config_name] = {
                 "host": config.host,
                 "port": config.port,
+                "protocol": config.protocol,
                 "database_name": config.database_name,
                 "user": config.user,
                 "password": config.password,
@@ -159,7 +163,7 @@ def register_database(config: DatabaseProjectConfig) -> None:
 
 def get_connection_string(config_name: str) -> str:
     config = get_database_config(config_name)
-    connection_string = f"postgresql://{config['user']}:{redact_string(config['password'])}@{config['host']}:{config['port']}/{config['database_name']}"
+    connection_string = f"{config['protocol']}://{config['user']}:{redact_string(config['password'])}@{config['host']}:{config['port']}/{config['database_name']}"
     return connection_string
 
 

{matrx_orm-2.0.1 → matrx_orm-2.0.2}/src/matrx_orm/python_sql/db_objects.py

@@ -184,7 +184,7 @@ def get_db_objects(schema, database_project):
         tuple: (processed_objects, full_relationships, full_junction_analysis, all_enum_base_types)
                where all_enum_base_types is a set of base types that have enum labels
     """
-    if info:
+    if debug:
         print("get_db_objects called with", database_project)
 
     # Retrieve the raw database objects

matrx_orm-2.0.2/tests/sample_project/database_registry.py

@@ -0,0 +1,52 @@
+from dotenv import load_dotenv
+
+load_dotenv()
+
+from matrx_utils.conf import settings, NotConfiguredError
+from matrx_utils import vcprint
+from matrx_orm import DatabaseProjectConfig, register_database
+from matrx_orm.core.config import DatabaseConfigError
+
+# ---------------------------------------------------------------------------
+# Primary database — Supabase (MY_MATRX project: viyklljfdhtidwecakwx)
+#
+# additional_schemas=["auth"] makes the ORM and schema builder aware of the
+# auth schema — auth.users FKs resolve via fetch_fk() without _unfetchable.
+# ---------------------------------------------------------------------------
+try:
+    primary_config = DatabaseProjectConfig(
+        name="primary",
+        alias="primary",
+        host=settings.PRIMARY_DB_HOST,
+        port=settings.PRIMARY_DB_PORT,
+        protocol=settings.PRIMARY_DB_PROTOCOL,
+        database_name=settings.PRIMARY_DB_NAME,
+        user=settings.PRIMARY_DB_USER,
+        password=settings.PRIMARY_DB_PASSWORD,
+        additional_schemas=["auth"],
+    )
+    register_database(primary_config)
+except (AttributeError, NotConfiguredError, DatabaseConfigError) as e:
+    vcprint(f"[sample_project] primary database not registered — missing env vars: {e}", color="yellow")
+
+# ---------------------------------------------------------------------------
+# Secondary database — Supabase (MATRX_DM project: deayzgwvqfdeskkdwudy)
+#
+# No cross-database FK relationships configured yet.
+# To add one later: ForeignKey(Users, to_column="id", to_db="primary")
+# ---------------------------------------------------------------------------
+try:
+    secondary_config = DatabaseProjectConfig(
+        name="secondary",
+        alias="secondary",
+        host=settings.SECONDARY_DB_HOST,
+        port=settings.SECONDARY_DB_PORT,
+        protocol=settings.SECONDARY_DB_PROTOCOL,
+        database_name=settings.SECONDARY_DB_NAME,
+        user=settings.SECONDARY_DB_USER,
+        password=settings.SECONDARY_DB_PASSWORD,
+        additional_schemas=[],
+    )
+    register_database(secondary_config)
+except (AttributeError, NotConfiguredError, DatabaseConfigError) as e:
+    vcprint(f"[sample_project] secondary database not registered — missing env vars: {e}", color="yellow")

matrx_orm-2.0.2/tests/sample_project/run_schema_generation.py

@@ -0,0 +1,61 @@
+import sys
+from pathlib import Path
+
+# Put this directory on the path so `import database_registry` works directly,
+# and put the src/ dir on the path so matrx_orm is importable without installing.
+_here = Path(__file__).parent.resolve()
+sys.path.insert(0, str(_here))
+sys.path.insert(0, str(_here.parent.parent / "src"))
+
+import database_registry  # noqa: E402  — registers primary + secondary databases
+
+from matrx_utils import clear_terminal, vcprint  # noqa: E402
+from matrx_orm.schema_builder import SchemaManager  # noqa: E402
+
+clear_terminal()
+
+# ---------------------------------------------------------------------------
+# Primary database — run this block to generate from the primary Supabase DB
+# ---------------------------------------------------------------------------
+schema = "public"
+database_project = "primary"
+additional_schemas = ["auth"]
+save_direct = False   # set True to write directly to ADMIN_PYTHON_ROOT
+
+schema_manager = SchemaManager(
+    schema=schema,
+    database_project=database_project,
+    additional_schemas=additional_schemas,
+    save_direct=save_direct,
+)
+schema_manager.initialize()
+
+matrx_schema_entry = schema_manager.schema.generate_schema_files()
+matrx_models = schema_manager.schema.generate_models()
+
+analysis = schema_manager.analyze_schema()
+vcprint(
+    data=analysis,
+    title="Schema Analysis — primary",
+    pretty=True,
+    verbose=False,
+    color="yellow",
+)
+
+schema_manager.schema.code_handler.print_all_batched()
+
+# ---------------------------------------------------------------------------
+# Secondary database — uncomment to also generate from the secondary DB
+# ---------------------------------------------------------------------------
+# schema_manager_2 = SchemaManager(
+#     schema="public",
+#     database_project="secondary",
+#     additional_schemas=[],
+#     save_direct=False,
+# )
+# schema_manager_2.initialize()
+# schema_manager_2.schema.generate_schema_files()
+# schema_manager_2.schema.generate_models()
+# analysis_2 = schema_manager_2.analyze_schema()
+# vcprint(data=analysis_2, title="Schema Analysis — secondary", pretty=True, verbose=False, color="cyan")
+# schema_manager_2.schema.code_handler.print_all_batched()

{matrx_orm-2.0.1 → matrx_orm-2.0.2}/tests/sample_project/test_schema_generation.py

@@ -45,7 +45,10 @@ pytestmark = pytest.mark.schema
 @pytest.fixture(scope="session", autouse=True)
 def register_sample_databases():
     """Register primary and secondary databases for the test session."""
-    from tests.sample_project.database_registry import setup_databases
+    import sys
+    from pathlib import Path
+    sys.path.insert(0, str(Path(__file__).parent))
+    from database_registry import setup_databases
     setup_databases()
 
 

{matrx_orm-2.0.1 → matrx_orm-2.0.2}/uv.lock

@@ -266,7 +266,7 @@ wheels = [
 
 [[package]]
 name = "matrx-orm"
-version = "1.6.4"
+version = "2.0.1"
 source = { editable = "." }
 dependencies = [
     { name = "asyncpg" },

matrx_orm-2.0.1/.env.example

@@ -1,12 +0,0 @@
-BASE_DIR=D:/work/matrx/matrx-orm
-
-SUPABASE_MATRX_URL=supabase_host_url
-DB_HOST=host
-DB_NAME=postgres
-DB_PORT=6543
-DB_USER=user
-DB_PASS=password
-SUPABASE_MATRX_JWT_SECRET=secret
-
-ADMIN_PYTHON_ROOT=D:/work/matrx/matrx-orm/temp/python-app
-ADMIN_TS_ROOT=D:/work/matrx/matrx-orm/temp/ts-app

matrx_orm-2.0.1/scripts/update_package.sh

@@ -1,200 +0,0 @@
-#!/usr/bin/env bash
-# update_package.sh — Bump version, update README, commit, tag, and push.
-#
-# Usage (run from anywhere inside the repo):
-#   ./scripts/update_package.sh              # patch bump  1.2.3 → 1.2.4  (default)
-#   ./scripts/update_package.sh --patch      # patch bump  1.2.3 → 1.2.4
-#   ./scripts/update_package.sh --minor      # minor bump  1.2.3 → 1.3.0
-#   ./scripts/update_package.sh --major      # major bump  1.2.3 → 2.0.0
-#   ./scripts/update_package.sh --message "fix: something"   # custom commit message
-#   ./scripts/update_package.sh --minor --message "feat: new stuff"
-#   ./scripts/update_package.sh --dry-run    # preview changes without committing
-
-set -euo pipefail
-
-# ── Resolve repo root ────────────────────────────────────────────────────────
-SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
-REPO_ROOT="$(cd "$SCRIPT_DIR/.." && pwd)"
-cd "$REPO_ROOT"
-
-PYPROJECT="pyproject.toml"
-README="README.md"
-REMOTE="origin"
-BRANCH="main"
-
-# ── Colors ───────────────────────────────────────────────────────────────────
-RED='\033[0;31m'
-GREEN='\033[0;32m'
-YELLOW='\033[1;33m'
-CYAN='\033[0;36m'
-BOLD='\033[1m'
-NC='\033[0m'
-
-info()    { echo -e "${CYAN}[INFO]${NC}  $*"; }
-ok()      { echo -e "${GREEN}[OK]${NC}    $*"; }
-warn()    { echo -e "${YELLOW}[WARN]${NC}  $*"; }
-fail()    { echo -e "${RED}[FAIL]${NC}  $*" >&2; exit 1; }
-preview() { echo -e "${YELLOW}[DRY]${NC}   $*"; }
-
-# ── Parse flags ──────────────────────────────────────────────────────────────
-BUMP_TYPE="patch"
-CUSTOM_MESSAGE=""
-DRY_RUN=false
-
-while [[ $# -gt 0 ]]; do
-    case "$1" in
-        --patch)   BUMP_TYPE="patch"; shift ;;
-        --minor)   BUMP_TYPE="minor"; shift ;;
-        --major)   BUMP_TYPE="major"; shift ;;
-        --message|-m)
-            [[ -n "${2:-}" ]] || fail "--message requires an argument."
-            CUSTOM_MESSAGE="$2"; shift 2 ;;
-        --dry-run) DRY_RUN=true; shift ;;
-        -h|--help)
-            grep '^#' "$0" | head -20 | sed 's/^# \?//'
-            exit 0 ;;
-        *) fail "Unknown flag: $1. Use --patch, --minor, --major, --message, or --dry-run." ;;
-    esac
-done
-
-# ── Pre-flight checks ────────────────────────────────────────────────────────
-[[ -f "$PYPROJECT" ]] || fail "$PYPROJECT not found. Cannot continue."
-[[ -f "$README"    ]] || fail "$README not found. Cannot continue."
-
-CURRENT_BRANCH=$(git rev-parse --abbrev-ref HEAD)
-[[ "$CURRENT_BRANCH" == "$BRANCH" ]] \
-    || fail "Not on '$BRANCH' branch (currently on '$CURRENT_BRANCH'). Switch first."
-
-if [[ -n "$(git diff --cached --name-only)" ]]; then
-    fail "Staged but uncommitted changes detected. Commit or unstage them first."
-fi
-
-if [[ -n "$(git diff --name-only HEAD)" ]]; then
-    warn "Unstaged changes in tracked files — they will be committed with the version bump."
-fi
-
-# ── Read current version ─────────────────────────────────────────────────────
-CURRENT_VERSION=$(grep '^version = ' "$PYPROJECT" | sed 's/version = "\(.*\)"/\1/')
-[[ -n "$CURRENT_VERSION" ]] || fail "Could not read version from $PYPROJECT."
-
-IFS='.' read -r MAJOR MINOR PATCH <<< "$CURRENT_VERSION"
-
-# ── Calculate new version ────────────────────────────────────────────────────
-case "$BUMP_TYPE" in
-    patch) NEW_VERSION="${MAJOR}.${MINOR}.$((PATCH + 1))" ;;
-    minor) NEW_VERSION="${MAJOR}.$((MINOR + 1)).0" ;;
-    major) NEW_VERSION="$((MAJOR + 1)).0.0" ;;
-esac
-
-NEW_TAG="v${NEW_VERSION}"
-
-# ── Check tag doesn't already exist ─────────────────────────────────────────
-if git rev-parse "$NEW_TAG" &>/dev/null; then
-    fail "Tag $NEW_TAG already exists. Resolve manually or choose a different bump type."
-fi
-
-# ── Build commit message ─────────────────────────────────────────────────────
-if [[ -n "$CUSTOM_MESSAGE" ]]; then
-    COMMIT_MSG="$CUSTOM_MESSAGE"
-else
-    case "$BUMP_TYPE" in
-        patch) COMMIT_MSG="chore: release v${NEW_VERSION}" ;;
-        minor) COMMIT_MSG="chore: release v${NEW_VERSION}" ;;
-        major) COMMIT_MSG="chore: release v${NEW_VERSION}" ;;
-    esac
-fi
-
-# ── Preview ──────────────────────────────────────────────────────────────────
-echo ""
-echo -e "${BOLD}  matrx-orm release${NC}"
-echo -e "  ─────────────────────────────────────────────"
-echo -e "  Bump type  : ${CYAN}${BUMP_TYPE}${NC}"
-echo -e "  Old version: ${YELLOW}${CURRENT_VERSION}${NC}"
-echo -e "  New version: ${GREEN}${NEW_VERSION}${NC}"
-echo -e "  Tag        : ${GREEN}${NEW_TAG}${NC}"
-echo -e "  Commit msg : ${CYAN}${COMMIT_MSG}${NC}"
-$DRY_RUN && echo -e "  Mode       : ${YELLOW}DRY RUN — nothing will be changed${NC}"
-echo -e "  ─────────────────────────────────────────────"
-echo ""
-
-if $DRY_RUN; then
-    preview "Would update version in $PYPROJECT:  $CURRENT_VERSION → $NEW_VERSION"
-    preview "Would prepend entry in $README version history table"
-    preview "Would commit: '$COMMIT_MSG'"
-    preview "Would create tag: $NEW_TAG"
-    preview "Would push: git push $REMOTE $BRANCH --tags"
-    echo ""
-    preview "Dry run complete. No changes made."
-    echo ""
-    exit 0
-fi
-
-# ── Update pyproject.toml ────────────────────────────────────────────────────
-info "Bumping version in $PYPROJECT..."
-sed -i "s/^version = \"${CURRENT_VERSION}\"/version = \"${NEW_VERSION}\"/" "$PYPROJECT"
-
-# Verify the change landed
-WRITTEN_VERSION=$(grep '^version = ' "$PYPROJECT" | sed 's/version = "\(.*\)"/\1/')
-[[ "$WRITTEN_VERSION" == "$NEW_VERSION" ]] \
-    || fail "Version write failed — $PYPROJECT still shows $WRITTEN_VERSION."
-ok "pyproject.toml → $NEW_VERSION"
-
-# ── Update README version history table ──────────────────────────────────────
-info "Inserting v${NEW_VERSION} entry in $README..."
-
-# Build the new row; use a placeholder message unless --message was given.
-if [[ -n "$CUSTOM_MESSAGE" ]]; then
-    README_ENTRY="| **v${NEW_VERSION}** | ${CUSTOM_MESSAGE} |"
-else
-    case "$BUMP_TYPE" in
-        patch) README_ENTRY="| **v${NEW_VERSION}** | Patch release |" ;;
-        minor) README_ENTRY="| **v${NEW_VERSION}** | Minor release |" ;;
-        major) README_ENTRY="| **v${NEW_VERSION}** | Major release |" ;;
-    esac
-fi
-
-# Insert the new row immediately after the "| Version | Highlights |" header row.
-# The table looks like:
-#   | Version | Highlights |
-#   |---|---|
-#   | **v1.4.3** | ... |   ← insert here
-ESCAPED_ENTRY=$(printf '%s\n' "$README_ENTRY" | sed 's/[\/&]/\\&/g')
-sed -i "/^| Version | Highlights |/{
-    n        # skip the separator row
-    n        # now on the first data row
-    i\\${ESCAPED_ENTRY}
-}" "$README"
-
-ok "README.md → added $NEW_VERSION to version history"
-
-# ── Commit ───────────────────────────────────────────────────────────────────
-info "Staging changed files..."
-git add "$PYPROJECT" "$README"
-
-# Also stage any unstaged tracked changes the user already had
-git add -u
-
-info "Committing..."
-git commit -m "$COMMIT_MSG"
-ok "Committed: '$COMMIT_MSG'"
-
-# ── Tag ──────────────────────────────────────────────────────────────────────
-info "Creating tag $NEW_TAG..."
-git tag "$NEW_TAG"
-ok "Tag $NEW_TAG created"
-
-# ── Push ─────────────────────────────────────────────────────────────────────
-info "Pushing commits and tag to $REMOTE/$BRANCH..."
-git push "$REMOTE" "$BRANCH" --tags
-ok "Pushed to $REMOTE/$BRANCH with tag $NEW_TAG"
-
-# ── Done ─────────────────────────────────────────────────────────────────────
-echo ""
-echo -e "${GREEN}━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━${NC}"
-echo -e "${GREEN}  Released matrx-orm ${NEW_VERSION}${NC}"
-echo -e "${GREEN}  GitHub Actions will now build and publish to PyPI.${NC}"
-echo -e "${GREEN}━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━${NC}"
-echo ""
-echo -e "  Monitor : ${CYAN}https://github.com/armanisadeghi/matrx-orm/actions${NC}"
-echo -e "  Install : ${CYAN}uv add matrx-orm@${NEW_VERSION}${NC}"
-echo ""

matrx_orm-2.0.1/tests/sample_project/database_registry.py

@@ -1,116 +0,0 @@
-"""
-Sample Project — Database Registry
-===================================
-This file demonstrates how to configure matrx-orm for a real-world multi-database
-setup. It registers:
-
-  1. ``primary``   — Main Supabase project (public schema + auth schema).
-                     All application tables live here. auth.users is automatically
-                     reachable because ``additional_schemas=["auth"]`` is set.
-
-  2. ``secondary`` — A second Supabase project (or any remote Postgres database).
-                     No cross-database relationships are declared yet; it is
-                     registered so you can run queries and schema generation
-                     against it independently.
-
-How to use
-----------
-Import this module once at application startup before any model or query code runs:
-
-    from tests.sample_project.database_registry import setup_databases
-    setup_databases()
-
-The setup_databases() call is idempotent — matrx-orm silently skips duplicate
-registrations, so it is safe to call from multiple entry points.
-
-Environment variables
----------------------
-All credentials are read from the environment (or from .env via python-dotenv).
-Copy .env.example → .env and fill in the real passwords before running.
-
-Supabase connection notes
--------------------------
-- Host format: db.<project-ref>.supabase.co
-- Port: 5432 (direct connection, not the pooler)
-- User: postgres
-- Database name: postgres
-- Password: the "Database Password" from Supabase → Settings → Database
-- SSL is required and handled automatically by matrx-orm's connection pool.
-"""
-
-import os
-from pathlib import Path
-
-# ---------------------------------------------------------------------------
-# Load .env from this directory (if present)
-# ---------------------------------------------------------------------------
-try:
-    from dotenv import load_dotenv
-    _env_path = Path(__file__).parent / ".env"
-    if _env_path.exists():
-        load_dotenv(_env_path)
-except ImportError:
-    # python-dotenv is optional — set env vars directly in your shell or CI
-    pass
-
-from matrx_orm import DatabaseProjectConfig, register_database
-
-
-def setup_databases() -> None:
-    """Register all database connections with matrx-orm."""
-
-    # ------------------------------------------------------------------
-    # 1. Primary database — main Supabase project (MY_MATRX)
-    #
-    # additional_schemas=["auth"] makes the auth schema visible to:
-    #   - Schema builder (generates auth.users stub model)
-    #   - ForeignKey resolution (fetch_fk on user_id columns works without
-    #     _unfetchable = True)
-    # ------------------------------------------------------------------
-    primary_password = os.environ.get("PRIMARY_DB_PASSWORD", "")
-    if primary_password:
-        primary_config = DatabaseProjectConfig(
-            name="primary",
-            alias="primary",
-            host=os.environ.get("PRIMARY_DB_HOST", "db.viyklljfdhtidwecakwx.supabase.co"),
-            port=os.environ.get("PRIMARY_DB_PORT", "5432"),
-            database_name=os.environ.get("PRIMARY_DB_NAME", "postgres"),
-            user=os.environ.get("PRIMARY_DB_USER", "postgres"),
-            password=primary_password,
-            additional_schemas=["auth"],   # exposes auth.users and other auth.* tables
-        )
-        register_database(primary_config)
-    else:
-        print("[sample_project] PRIMARY_DB_PASSWORD not set — skipping primary database registration.")
-
-    # ------------------------------------------------------------------
-    # 2. Secondary database — second Supabase project (MATRX_DM)
-    #
-    # No additional_schemas declared — only the public schema is introspected.
-    # No cross-database ForeignKey relationships are configured here yet.
-    # To add cross-database FK fetching later, use:
-    #   user_id = ForeignKey(Users, to_column="id", to_db="primary")
-    # ------------------------------------------------------------------
-    secondary_password = os.environ.get("SECONDARY_DB_PASSWORD", "")
-    if secondary_password:
-        secondary_config = DatabaseProjectConfig(
-            name="secondary",
-            alias="secondary",
-            host=os.environ.get("SECONDARY_DB_HOST", "db.deayzgwvqfdeskkdwudy.supabase.co"),
-            port=os.environ.get("SECONDARY_DB_PORT", "5432"),
-            database_name=os.environ.get("SECONDARY_DB_NAME", "postgres"),
-            user=os.environ.get("SECONDARY_DB_USER", "postgres"),
-            password=secondary_password,
-            additional_schemas=[],   # public schema only for now
-        )
-        register_database(secondary_config)
-    else:
-        print("[sample_project] SECONDARY_DB_PASSWORD not set — skipping secondary database registration.")
-
-
-# Run when imported directly for quick validation
-if __name__ == "__main__":
-    setup_databases()
-    print("Database registry configured successfully.")
-    print("  primary   → db.viyklljfdhtidwecakwx.supabase.co (auth schema enabled)")
-    print("  secondary → db.deayzgwvqfdeskkdwudy.supabase.co (public schema only)")

matrx_orm-2.0.1/tests/sample_project/run_schema_generation.py

@@ -1,156 +0,0 @@
-"""
-Sample Project — Schema Generation Runner
-==========================================
-Demonstrates the full schema generation workflow against real databases.
-
-Run from the repository root:
-
-    python tests/sample_project/run_schema_generation.py
-
-Or run a specific database only:
-
-    python tests/sample_project/run_schema_generation.py --db primary
-    python tests/sample_project/run_schema_generation.py --db secondary
-
-What this script does
----------------------
-For each configured database it:
-  1. Registers the database config (reads credentials from .env)
-  2. Initialises SchemaManager — introspects tables, views, columns, FK/IFK/M2M
-  3. Generates Python model + manager files  → generated/<db_name>/models/
-  4. Generates JSON schema files            → generated/<db_name>/schema/
-  5. Prints a summary analysis to stdout
-
-The ``generated/`` directory is gitignored — it is safe to delete and regenerate
-at any time.
-
-Typical output structure
-------------------------
-tests/sample_project/
-├── generated/
-│   ├── primary/
-│   │   ├── models/          ← Python Model + Manager files
-│   │   └── schema/          ← JSON schema files
-│   └── secondary/
-│       ├── models/
-│       └── schema/
-"""
-
-import argparse
-import sys
-import os
-from pathlib import Path
-
-# Allow running from the repo root without installing the package
-sys.path.insert(0, str(Path(__file__).parent.parent.parent / "src"))
-
-# Register databases first
-from tests.sample_project.database_registry import setup_databases  # noqa: E402
-
-setup_databases()
-
-from matrx_orm.schema_builder.schema_manager import SchemaManager  # noqa: E402
-
-# Output base directory — gitignored
-OUTPUT_BASE = Path(__file__).parent / "generated"
-
-DATABASES = {
-    "primary": {
-        "database_project": "primary",
-        "schema": "public",
-        "additional_schemas": ["auth"],
-        "description": "Main Supabase project (public + auth schemas)",
-    },
-    "secondary": {
-        "database_project": "secondary",
-        "schema": "public",
-        "additional_schemas": [],
-        "description": "Second Supabase project (public schema only)",
-    },
-}
-
-
-def run_generation(db_name: str, cfg: dict) -> dict:
-    """Run full schema generation for one database. Returns a summary dict."""
-    output_dir = OUTPUT_BASE / db_name
-    output_dir.mkdir(parents=True, exist_ok=True)
-
-    print(f"\n{'='*60}")
-    print(f"  Database: {db_name}")
-    print(f"  {cfg['description']}")
-    print(f"  Output:   {output_dir}")
-    print(f"{'='*60}")
-
-    print(f"\n[{db_name}] Initialising SchemaManager...")
-    sm = SchemaManager(
-        schema=cfg["schema"],
-        database_project=cfg["database_project"],
-        additional_schemas=cfg["additional_schemas"],
-        save_direct=False,
-    )
-    sm.initialize()
-
-    table_count = len(sm.schema.tables) if hasattr(sm.schema, "tables") else "?"
-    view_count = len(sm.schema.views) if hasattr(sm.schema, "views") else "?"
-    print(f"[{db_name}] Introspected {table_count} tables, {view_count} views.")
-
-    print(f"[{db_name}] Generating schema files...")
-    schema_entry = sm.schema.generate_schema_files()
-
-    print(f"[{db_name}] Generating Python model + manager files...")
-    models = sm.schema.generate_models()
-
-    print(f"[{db_name}] Running schema analysis...")
-    analysis = sm.analyze_schema()
-
-    summary = {
-        "db": db_name,
-        "tables": table_count,
-        "views": view_count,
-        "analysis": analysis,
-    }
-
-    print(f"[{db_name}] Done.")
-    return summary
-
-
-def main() -> None:
-    parser = argparse.ArgumentParser(
-        description="matrx-orm sample project — schema generation runner"
-    )
-    parser.add_argument(
-        "--db",
-        choices=list(DATABASES.keys()) + ["all"],
-        default="all",
-        help="Which database to generate (default: all)",
-    )
-    args = parser.parse_args()
-
-    target_dbs = list(DATABASES.items()) if args.db == "all" else [(args.db, DATABASES[args.db])]
-
-    results = []
-    errors = []
-
-    for db_name, cfg in target_dbs:
-        try:
-            summary = run_generation(db_name, cfg)
-            results.append(summary)
-        except Exception as exc:
-            print(f"\n[{db_name}] ERROR: {exc}")
-            errors.append((db_name, exc))
-
-    # Final summary
-    print(f"\n{'='*60}")
-    print("  Schema Generation Complete")
-    print(f"{'='*60}")
-    for r in results:
-        print(f"  {r['db']:12s}  {r['tables']} tables, {r['views']} views")
-    for db_name, exc in errors:
-        print(f"  {db_name:12s}  FAILED: {exc}")
-
-    if errors:
-        sys.exit(1)
-
-
-if __name__ == "__main__":
-    main()