schemap-tool 0.6.0__tar.gz

schemap_tool-0.6.0/.gitattributes

@@ -0,0 +1,2 @@
+# Auto detect text files and perform LF normalization
+* text=auto

schemap_tool-0.6.0/.github/workflows/schemap.yml

@@ -0,0 +1,33 @@
+name: Update Schemap Context
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - 'migrations/**'
+      - 'alembic/versions/**'
+
+jobs:
+  update-schema-map:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      
+      - name: Install uv
+        uses: astral-sh/setup-uv@v3
+        with:
+          version: "0.1.0"
+          
+      - name: Run Schemap Generate
+        run: |
+          # Note: Ensure your CI environment variables include your database credentials.
+          uv run schemap generate
+          
+      - name: Commit and Push Context Map
+        run: |
+          git config --global user.name 'github-actions[bot]'
+          git config --global user.email 'github-actions[bot]@users.noreply.github.com'
+          git add llm_data_context.md
+          # Only commit if there are changes
+          git diff --quiet && git diff --staged --quiet || (git commit -m "docs: auto-update llm_data_context.md" && git push)

schemap_tool-0.6.0/PKG-INFO

@@ -0,0 +1,19 @@
+Metadata-Version: 2.4
+Name: schemap-tool
+Version: 0.6.0
+Summary: A deterministic tool that outputs highly compressed database schemas
+Author-email: Data Architect <architect@example.com>
+Requires-Python: >=3.9
+Requires-Dist: click>=8.1.0
+Requires-Dist: jinja2>=3.1.0
+Requires-Dist: libsql
+Requires-Dist: oracledb
+Requires-Dist: psycopg[binary]>=3.1.0
+Requires-Dist: pydantic>=2.6.0
+Requires-Dist: pymysql
+Requires-Dist: pyyaml>=6.0.0
+Requires-Dist: tiktoken>=0.6.0
+Requires-Dist: watchdog>=4.0.0
+Provides-Extra: dev
+Requires-Dist: pytest-mock>=3.10.0; extra == 'dev'
+Requires-Dist: pytest>=8.0.0; extra == 'dev'

schemap_tool-0.6.0/README.md

@@ -0,0 +1,108 @@
+<div align="center">
+  <img src="docs/assets/Text_Logo__Dark_-removebg-preview.png" alt="Schemap Logo" width="300" />
+</div>
+
+<br/>
+
+<div align="center">
+  <strong>Token-Optimized Database Context for AI Pipelines.</strong>
+</div>
+
+<div align="center">
+  Don't waste 50,000 tokens on raw SQL dumps. Schemap is a zero-friction CLI that condenses your database schema into an LLM-perfect data contract.
+</div>
+
+<br/>
+
+## Why Schemap?
+
+When building AI agents or RAG pipelines that interact with databases, developers usually dump raw `pg_dump` schemas into the context window. This wastes massive amounts of tokens, causes the LLM to hallucinate over irrelevant system tables, and breaks easily when schemas change.
+
+**Schemap solves this.**
+It natively connects to your database, strips out the noise, and generates a highly compressed, token-optimized Markdown file representing your exact data contract.
+
+- **Zero-Friction:** No heavy setup. Generates a clean config in one command.
+- **Multi-Dialect Routing:** Native support for PostgreSQL, MySQL, Oracle, Turso/libSQL, and SQLite.
+- **Token Estimation:** Automatically calculates your exact token footprint (`~4,894 tokens`).
+- **CI/CD Native:** Automatically run it in GitHub Actions to keep your context maps perfectly synced with your migrations.
+
+## Installation
+
+Schemap is published on PyPI. Install it globally or within your project environment:
+
+```bash
+pip install schemap
+```
+
+*(Note: We highly recommend using [uv](https://github.com/astral-sh/uv) for blazing-fast environment management.)*
+
+## Quick Start
+
+1. **Initialize the configuration:**
+   Run the following command in your project root to generate a boilerplate `schemap.yaml` file:
+   ```bash
+   schemap init
+   ```
+
+2. **Configure your connection:**
+   Open `schemap.yaml` and paste your database connection URL. You can also define wildcard exclusions to ignore system tables.
+   ```yaml
+   database:
+     connection_url: "postgresql://user:password@localhost:5432/my_db"
+     exclude_tables:
+       - "spatial_ref_sys"
+       - "alembic_version"
+       - "*_history"
+   ```
+
+3. **Generate your context map:**
+   ```bash
+   schemap generate
+   ```
+   *Output:*
+   ```text
+   -> Loading configuration from ./schemap.yaml... OK
+   -> Connecting to database... Connected. Found 39 active tables
+   -> Validating schema objects contract... OK
+   -> Compiling context engine via Jinja2... OK
+   [SUCCESS] Context map generated successfully at ./llm_data_context.md [14.0 KB / ~4,894 tokens]
+   ```
+
+## Supported Databases
+
+- PostgreSQL (`postgresql://...`)
+- Turso / remote libSQL (`libsql://...`)
+- Local SQLite (`sqlite:///...`)
+- MySQL (`mysql://...`)
+- Oracle (`oracle://...`)
+
+## Continuous Integration (CI/CD)
+
+Want to automate your context map generation every time you merge a database migration?
+
+Run:
+```bash
+schemap init-ci
+```
+This drops a ready-to-use `.github/workflows/schemap.yml` action into your repository that runs Schemap and commits the new Markdown file automatically.
+
+## Licensing
+
+Schemap operates on a Frictionless License Model. 
+- **Developer Tier (Free):** Use Schemap for free locally on databases with up to 10 tables.
+- **Professional & Team Tiers:** For unlimited tables, wildcard filtering, and CI/CD pipeline automation, purchase a license key at [schemap.com](https://your-username.github.io/schemap).
+
+Once purchased, simply drop your key into the `schemap.yaml`:
+```yaml
+database:
+  license_key: "YOUR_LICENSE_KEY_HERE"
+```
+
+## Built With
+- `psycopg` (PostgreSQL)
+- `libsql` (Turso)
+- `pymysql` (MySQL)
+- `oracledb` (Oracle)
+- `pydantic` v2 (Strict type-safety)
+- `jinja2` (Markdown compilation)
+- `tiktoken` (Token counting)

schemap_tool-0.6.0/docs/app.js

@@ -0,0 +1,58 @@
+document.addEventListener('DOMContentLoaded', () => {
+    // Typing effect for the terminal
+    const cmdElement = document.getElementById('type-cmd');
+    const originalText = "uv run schemap generate";
+    cmdElement.textContent = "";
+    
+    // Add cursor
+    const cursor = document.createElement('span');
+    cursor.className = 'cursor';
+    cmdElement.parentNode.appendChild(cursor);
+
+    let i = 0;
+    const typeInterval = setInterval(() => {
+        if (i < originalText.length) {
+            cmdElement.textContent += originalText.charAt(i);
+            i++;
+        } else {
+            clearInterval(typeInterval);
+            // Wait 500ms then remove cursor and show output
+            setTimeout(() => {
+                cursor.remove();
+                showOutput();
+            }, 500);
+        }
+    }, 100);
+
+    function showOutput() {
+        const delays = [400, 800, 1000, 1100, 1300];
+        for (let j = 1; j <= 5; j++) {
+            setTimeout(() => {
+                const el = document.getElementById(`out-${j}`);
+                if (el) {
+                    el.classList.remove('hidden');
+                }
+            }, delays[j-1]);
+        }
+    // Copy Install Command functionality
+    const copyBtn = document.getElementById('copy-install-btn');
+    if (copyBtn) {
+        copyBtn.addEventListener('click', (e) => {
+            e.preventDefault();
+            navigator.clipboard.writeText('pip install schemap').then(() => {
+                const originalText = copyBtn.textContent;
+                copyBtn.textContent = 'Copied to Clipboard!';
+                copyBtn.style.color = 'var(--success)';
+                copyBtn.style.borderColor = 'var(--success)';
+                
+                setTimeout(() => {
+                    copyBtn.textContent = originalText;
+                    copyBtn.style.color = '';
+                    copyBtn.style.borderColor = '';
+                }, 2000);
+            }).catch(err => {
+                console.error('Failed to copy: ', err);
+            });
+        });
+    }
+});

schemap_tool-0.6.0/docs/index.html

@@ -0,0 +1,205 @@
+<!DOCTYPE html>
+<html lang="en">
+
+<head>
+    <meta charset="UTF-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <title>Schemap | Token-Optimized Database Context</title>
+    <link rel="preconnect" href="https://fonts.googleapis.com">
+    <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
+    <link
+        href="https://fonts.googleapis.com/css2?family=Red+Hat+Display:wght@400;500;700&family=JetBrains+Mono:wght@400;500&display=swap"
+        rel="stylesheet">
+    <link rel="stylesheet" href="style.css?v=2">
+    <link rel="icon" type="image/png" href="assets/Icon Dark.png">
+</head>
+
+<body>
+    <nav class="navbar">
+        <div class="nav-container">
+            <a href="#" class="logo">
+                <img src="assets/Text_Logo__Dark_-removebg-preview2.png" alt="Schemap Logo" class="nav-logo">
+            </a>
+            <div class="nav-links">
+                <a href="#features" class="hide-mobile">Features</a>
+                <a href="#pricing" class="hide-mobile">Pricing</a>
+                <a href="https://github.com/alansyahmi/Schemap" target="_blank" class="nav-btn hide-mobile">GitHub</a>
+                <a href="#installation" class="btn btn-primary show-mobile"
+                    style="color: #000 !important; font-weight: 600; padding: 0.5rem 1rem; font-size: 0.875rem; margin-left: 1rem;">Get
+                    for Free</a>
+            </div>
+        </div>
+    </nav>
+
+    <header class="hero">
+        <div class="hero-content">
+            <div class="badge">v0.1.0 Released</div>
+            <h1 class="hero-title">Token-Optimized Database Context for AI Pipelines.</h1>
+            <p class="hero-subtitle">Don't waste 50,000 tokens on raw SQL dumps. Schemap is a zero-friction CLI that
+                condenses your database schema into an LLM-perfect data contract.</p>
+            <div class="hero-actions">
+                <a href="#pricing" class="btn btn-primary">Get License Key</a>
+                <a href="#installation" class="btn btn-secondary">Install Now</a>
+            </div>
+        </div>
+
+        <div class="hero-terminal">
+            <div class="terminal-header">
+                <div class="mac-btns">
+                    <span class="close"></span>
+                    <span class="minimize"></span>
+                    <span class="maximize"></span>
+                </div>
+                <div class="terminal-title">bash</div>
+            </div>
+            <div class="terminal-body" id="terminal-body">
+                <div class="line"><span class="prompt">$</span> <span class="command" id="type-cmd">uv run schemap
+                        generate</span></div>
+                <div class="output hidden" id="out-1"><span class="success">-&gt;</span> Loading configuration from
+                    ./schemap.yaml... <span class="success">OK</span></div>
+                <div class="output hidden" id="out-2"><span class="success">-&gt;</span> Connecting to database... <span
+                        class="success">Connected. Found 39 active tables</span></div>
+                <div class="output hidden" id="out-3"><span class="success">-&gt;</span> Validating schema objects
+                    contract... <span class="success">OK</span></div>
+                <div class="output hidden" id="out-4"><span class="success">-&gt;</span> Compiling context engine via
+                    Jinja2... <span class="success">OK</span></div>
+                <div class="output hidden" id="out-5"><br><span class="success-bold">[SUCCESS]</span> Context map
+                    generated successfully at ./llm_data_context.md <span class="highlight-token">[14.0 KB / ~4,894
+                        tokens]</span></div>
+            </div>
+        </div>
+    </header>
+
+    <section id="features" class="features">
+        <div class="section-container">
+            <h2 class="section-title">Built for the Modern AI Engineer</h2>
+            <p class="section-subtitle">A highly decoupled Python pipeline enforcing strict data contracts.</p>
+
+            <div class="feature-grid">
+                <div class="feature-card">
+                    <div class="feature-icon">
+                        <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
+                            stroke-width="2" stroke-linecap="round" stroke-linejoin="round">
+                            <path d="M10 13a5 5 0 0 0 7.54.54l3-3a5 5 0 0 0-7.07-7.07l-1.72 1.71"></path>
+                            <path d="M14 11a5 5 0 0 0-7.54-.54l-3 3a5 5 0 0 0 7.07 7.07l1.71-1.71"></path>
+                        </svg>
+                    </div>
+                    <h3>Multi-Dialect Routing</h3>
+                    <p>Natively connects to PostgreSQL, Turso/libSQL, MySQL, Oracle, and local SQLite with zero instant
+                        client dependencies required.</p>
+                </div>
+                <div class="feature-card">
+                    <div class="feature-icon">
+                        <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
+                            stroke-width="2" stroke-linecap="round" stroke-linejoin="round">
+                            <circle cx="12" cy="12" r="10"></circle>
+                            <polyline points="12 6 12 12 16 14"></polyline>
+                        </svg>
+                    </div>
+                    <h3>The Leaky Bucket Cache</h3>
+                    <p>If you're hacking on an airplane or the network drops, Schemap's obfuscated offline cache gives
+                        you a 72-hour grace period.</p>
+                </div>
+                <div class="feature-card">
+                    <div class="feature-icon">
+                        <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
+                            stroke-width="2" stroke-linecap="round" stroke-linejoin="round">
+                            <path
+                                d="M20 16V7a2 2 0 0 0-2-2H6a2 2 0 0 0-2 2v9m16 0H4m16 0 1.28 2.55a1 1 0 0 1-.9 1.45H3.62a1 1 0 0 1-.9-1.45L4 16">
+                            </path>
+                        </svg>
+                    </div>
+                    <h3>CI/CD Pipeline Native</h3>
+                    <p>Run `uv run schemap init-ci` to automatically generate a GitHub Action. Your context window stays
+                        up-to-date with every PR.</p>
+                </div>
+            </div>
+        </div>
+    </section>
+
+    <section id="installation" class="installation">
+        <div class="section-container">
+            <div class="install-card">
+                <h2>Install in 2 Seconds</h2>
+                <p>Schemap leverages `uv` to maintain a zero-friction footprint.</p>
+                <div class="code-block">
+                    <code>pip install schemap</code>
+                </div>
+                <div class="code-block mt">
+                    <code>uv run schemap init</code>
+                </div>
+                <p class="install-desc">This generates your <code>schemap.yaml</code>. Update it with your database connection details:</p>
+                <div class="code-block mt" style="background: rgba(0,0,0,0.5); padding: 1.5rem; text-align: left; font-size: 0.85rem; line-height: 1.5;">
+<code style="color: var(--text-secondary); white-space: pre-wrap;"><span style="color: var(--accent);">database:</span>
+  url: <span style="color: var(--success);">"libsql://my-database.turso.io"</span>
+  <span style="color: #6b7280;"># Provide your auth token directly or use SCHEMAP_AUTH_TOKEN env var</span>
+  auth_token: <span style="color: var(--success);">"your-database-auth-token"</span>
+
+<span style="color: var(--accent);">license_key:</span> <span style="color: var(--success);">"your-license-key"</span></code>
+                </div>
+            </div>
+        </div>
+    </section>
+
+    <section id="pricing" class="pricing">
+        <div class="section-container">
+            <h2 class="section-title">Frictionless Licensing</h2>
+            <p class="section-subtitle">Simple, lifetime value. No heavy web logins required.</p>
+
+            <div class="pricing-grid">
+                <div class="price-card">
+                    <div class="tier-name">Developer</div>
+                    <div class="price">Free</div>
+                    <p class="tier-desc">For students and indie devs building local side projects.</p>
+                    <ul class="features-list">
+                        <li>Maximum 10 database tables</li>
+                        <li>Local execution only</li>
+                        <li>Markdown code generation</li>
+                        <li>Token estimations</li>
+                    </ul>
+                    <button id="copy-install-btn" class="btn btn-secondary full-width"
+                        style="font-family: inherit; font-size: 1rem; cursor: pointer;">Copy Install Command</button>
+                </div>
+
+                <div class="price-card featured">
+                    <div class="featured-badge">Most Popular</div>
+                    <div class="tier-name">Professional</div>
+                    <div class="price">$49<span class="period">/mo</span></div>
+                    <p class="tier-desc">For solo AI engineers and early-stage startups.</p>
+                    <ul class="features-list">
+                        <li><strong>Unlimited</strong> database tables</li>
+                        <li>Up to 3 active database connections</li>
+                        <li>Email support</li>
+                        <li>Wildcard exclusion globbing</li>
+                    </ul>
+                    <a href="#" class="btn btn-primary full-width">Buy License</a>
+                </div>
+
+                <div class="price-card">
+                    <div class="tier-name">Team</div>
+                    <div class="price">$99<span class="period">/mo</span></div>
+                    <p class="tier-desc">For tech teams needing automated context synchronization.</p>
+                    <ul class="features-list">
+                        <li><strong>Unlimited</strong> database tables</li>
+                        <li><strong>CI/CD Pipeline Execution</strong></li>
+                        <li>Automated GitHub Actions sync</li>
+                        <li>Priority team support</li>
+                    </ul>
+                    <a href="#" class="btn btn-secondary full-width">Buy Team License</a>
+                </div>
+            </div>
+        </div>
+    </section>
+
+    <footer>
+        <div class="footer-content">
+            <img src="assets/Icon Dark.png" alt="Schemap Icon" height="24">
+            <p>&copy; 2026 Schemap. A zero-friction dev tool.</p>
+            <p>Developed by Swarty</p>
+        </div>
+    </footer>
+
+    <script src="app.js"></script>
+</body>
+
+</html>