laranex-schema-viewer 0.1.0__tar.gz

laranex_schema_viewer-0.1.0/.gh-page/.vitepress/config.mts

@@ -0,0 +1,71 @@
+import { defineConfig } from 'vitepress'
+import { fileURLToPath } from 'node:url'
+import { createRequire } from 'node:module'
+
+const base = '/python-schema-viewer/'
+const repository = 'https://github.com/laranex/python-schema-viewer'
+const require = createRequire(import.meta.url)
+
+export default defineConfig({
+  title: 'Laranex Schema Viewer',
+  description: 'Explore SQLAlchemy and SQLModel definitions with an interactive ERD, portable JSON snapshots, and read-only MCP tools.',
+  lang: 'en-US',
+  base,
+  cleanUrls: false,
+  appearance: true,
+  srcDir: '../docs',
+  srcExclude: ['README.md', 'architecture.md', 'validation.md', 'agent-skills-validation.md'],
+  vite: {
+    publicDir: fileURLToPath(new URL('../public', import.meta.url)),
+    // Markdown lives outside the Node project; resolve Vue from this project.
+    resolve: { alias: [
+      { find: /^vue$/, replacement: require.resolve('vue/dist/vue.runtime.esm-bundler.js') },
+      { find: 'vue/server-renderer', replacement: require.resolve('vue/server-renderer') },
+    ] },
+  },
+  lastUpdated: false,
+  sitemap: { hostname: 'https://laranex.github.io/python-schema-viewer/' },
+  head: [
+    ['link', { rel: 'icon', type: 'image/svg+xml', href: `${base}logo.svg` }],
+    ['meta', { name: 'theme-color', content: '#0b7f6b' }],
+    ['meta', { property: 'og:type', content: 'website' }],
+    ['meta', { property: 'og:site_name', content: 'Laranex Schema Viewer' }],
+  ],
+  markdown: { theme: { light: 'github-light', dark: 'github-dark' }, lineNumbers: false },
+  themeConfig: {
+    logo: '/logo.svg',
+    siteTitle: 'Laranex',
+    nav: [
+      { text: 'Python Schema Viewer', link: '/introduction' },
+      { text: 'Live demo', link: '/demo' },
+      { text: 'Laranex projects ↗', link: 'https://laranex.vercel.app/' },
+    ],
+    sidebar: [
+      { text: 'GET STARTED', items: [
+        { text: 'Introduction', link: '/introduction' },
+        { text: 'Installation', link: '/installation' },
+        { text: 'Quick start', link: '/quick-start' },
+      ] },
+      { text: 'WORK WITH YOUR SCHEMA', items: [
+        { text: 'SQLAlchemy', link: '/sqlalchemy' },
+        { text: 'SQLModel', link: '/sqlmodel' },
+        { text: 'Discovery & extraction', link: '/discovery' },
+        { text: 'Interactive viewer', link: '/viewer' },
+        { text: 'Live demo', link: '/demo' },
+      ] },
+      { text: 'REFERENCE', items: [
+        { text: 'CLI & configuration', link: '/cli' },
+        { text: 'MCP for agents', link: '/mcp' },
+        { text: 'Agent skills', link: '/agent-skills' },
+        { text: 'Troubleshooting', link: '/troubleshooting' },
+      ] },
+    ],
+    search: { provider: 'local', options: { detailedView: true } },
+    outline: { level: [2, 3], label: 'On this page' },
+    socialLinks: [{ icon: 'github', link: repository }],
+    editLink: { pattern: `${repository}/edit/main/docs/:path`, text: 'Improve this page on GitHub' },
+    footer: { message: 'Open source under the MIT license.', copyright: 'Laranex · Built by developers, for developers.' },
+    docFooter: { prev: 'Previous page', next: 'Next page' },
+    externalLinkIcon: true,
+  },
+})

laranex_schema_viewer-0.1.0/.gh-page/.vitepress/theme/LiveDemo.vue

@@ -0,0 +1,24 @@
+<script setup>
+import { computed, onMounted, ref, watch } from 'vue'
+import { useData, withBase } from 'vitepress'
+
+const { isDark } = useData()
+const frame = ref(null)
+const ready = ref(false)
+const src = computed(() => withBase('/demo/index.html'))
+function syncTheme() {
+  const root = frame.value?.contentDocument?.documentElement
+  if (root) root.dataset.theme = isDark.value ? 'dark' : 'light'
+}
+function loaded() { ready.value = true; syncTheme() }
+watch(isDark, syncTheme)
+onMounted(syncTheme)
+</script>
+
+<template>
+  <section class="lx-demo" aria-label="Synthetic schema demonstration">
+    <div class="lx-demo-bar"><span><i></i> INTERACTIVE DEMO</span><span>Synthetic workspace · no backend</span></div>
+    <iframe ref="frame" :src="src" title="Interactive ERD of a synthetic project workspace" loading="lazy" @load="loaded"></iframe>
+    <div class="lx-demo-footer"><span>{{ ready ? 'Drag to explore · scroll to zoom · select for details' : 'Loading the demo when it comes into view…' }}</span><a :href="src" target="_blank" rel="noopener">Open full screen ↗</a></div>
+  </section>
+</template>

laranex_schema_viewer-0.1.0/.gh-page/.vitepress/theme/PackageIntroduction.vue

@@ -0,0 +1,28 @@
+<script setup>
+import { ref } from 'vue'
+import { withBase } from 'vitepress'
+
+const command = "pip install 'laranex-schema-viewer[sqlmodel,mcp]'"
+const message = ref('Copy command')
+async function copy() {
+  try {
+    await navigator.clipboard.writeText(command)
+    message.value = 'Copied'
+  } catch {
+    message.value = 'Select and copy the command below'
+  }
+}
+</script>
+
+<template>
+  <header class="lx-package">
+    <p class="lx-eyebrow"><span></span> PYTHON TOOLING, WITH A CLEARER PICTURE</p>
+    <h1>Laranex<br /><span>Schema Viewer</span></h1>
+    <p class="lx-lead">Understand how your data fits together.<br />Tables, constraints, and ORM relationships — in one explorable view.</p>
+    <div class="lx-tags"><span>SQLAlchemy 2.x</span><span>SQLModel</span><span>Read-only MCP</span><span>MIT</span></div>
+    <div class="lx-install"><span aria-hidden="true">$</span><code>{{ command }}</code><button @click="copy" :aria-label="message">{{ message === 'Copied' ? 'Copied ✓' : 'Copy' }}</button></div>
+    <p class="lx-caption">Requires Python 3.10+. Choose the <code>sqlalchemy</code> or <code>sqlmodel</code> extra; add <code>mcp</code> for agents.</p>
+    <span class="sr-only" role="status">{{ message }}</span>
+    <div class="lx-actions"><a class="lx-button primary" :href="withBase('/quick-start.html')">Get started <span aria-hidden="true">→</span></a><a class="lx-button secondary" :href="withBase('/demo.html')">Explore the live demo</a></div>
+  </header>
+</template>

laranex_schema_viewer-0.1.0/.gh-page/.vitepress/theme/custom.css

@@ -0,0 +1,82 @@
+/* Laranex design vocabulary, with VitePress's responsive navigation and search. */
+:root {
+  --vp-font-family-base: 'Geist Variable', ui-sans-serif, system-ui, sans-serif;
+  --vp-font-family-mono: 'Geist Mono Variable', ui-monospace, monospace;
+  --vp-c-brand-1: #0b7f6b;
+  --vp-c-brand-2: #129e85;
+  --vp-c-brand-3: #18b69b;
+  --vp-c-brand-soft: rgba(24, 182, 155, .1);
+  --vp-c-text-1: #0e1a21;
+  --vp-c-text-2: #4d5d68;
+  --vp-c-bg-alt: #f5f8f9;
+  --vp-c-bg-soft: #f5f8f9;
+  --vp-c-divider: #e3e9ec;
+  --vp-code-block-bg: #f6f9fa;
+  --vp-layout-max-width: 1480px;
+  --vp-sidebar-width: 264px;
+  --vp-button-brand-bg: #0b7f6b;
+  --vp-button-brand-hover-bg: #096b5a;
+}
+.dark {
+  --vp-c-brand-1: #34d3b6;
+  --vp-c-brand-2: #2fcfb2;
+  --vp-c-brand-3: #18b69b;
+  --vp-c-text-1: #e6eff2;
+  --vp-c-text-2: #98abb4;
+  --vp-c-bg: #0a1014;
+  --vp-c-bg-alt: #080d10;
+  --vp-c-bg-soft: #10191f;
+  --vp-c-bg-elv: #121c22;
+  --vp-c-divider: #1e2b33;
+  --vp-code-block-bg: #0d151a;
+  --vp-c-brand-soft: rgba(24, 182, 155, .14);
+}
+body { -webkit-font-smoothing: antialiased; }
+::selection { background: rgba(24, 182, 155, .24); }
+:focus-visible { outline: 2px solid var(--vp-c-brand-1); outline-offset: 4px; }
+.VPNavBar { backdrop-filter: blur(16px); }
+.VPNavBarTitle .title { font-weight: 650; letter-spacing: -.5px; }
+.VPNavBarTitle .logo { width: 29px; height: 29px; }
+.VPSidebarItem.level-0 > .item > .text { font-size: 10px; letter-spacing: 1.3px; font-weight: 650; color: var(--vp-c-text-2); }
+.vp-doc h1 { letter-spacing: -1.5px; }
+.vp-doc h2 { letter-spacing: -.65px; }
+.vp-doc div[class*='language-'] { border: 1px solid var(--vp-c-divider); border-radius: 10px; }
+.sr-only { position: absolute; width: 1px; height: 1px; overflow: hidden; clip: rect(0, 0, 0, 0); }
+.lx-package { padding: 12px 0 30px; position: relative; }
+.lx-eyebrow { color: var(--vp-c-brand-1); font-size: 10px; letter-spacing: 1.8px; font-weight: 650; display: flex; align-items: center; gap: 9px; }
+.lx-eyebrow span { width: 6px; height: 6px; border-radius: 50%; background: #18b69b; box-shadow: 0 0 0 4px var(--vp-c-brand-soft); }
+.vp-doc .lx-package h1 { margin: 25px 0 20px; font-size: clamp(38px, 5.1vw, 66px); line-height: 1.07; letter-spacing: -2.5px; font-weight: 650; }
+.lx-package h1 span { color: var(--vp-c-brand-1); }
+.vp-doc .lx-lead { font-size: 18px; line-height: 1.75; color: var(--vp-c-text-2); }
+.lx-tags { display: flex; gap: 8px; flex-wrap: wrap; margin: 22px 0; }
+.lx-tags span { font-size: 11px; border: 1px solid var(--vp-c-divider); background: var(--vp-c-bg-soft); border-radius: 5px; padding: 2px 9px; }
+.lx-install { display: flex; align-items: center; gap: 13px; border: 1px solid var(--vp-c-divider); background: var(--vp-c-bg-soft); border-radius: 9px; padding: 10px 14px; max-width: 640px; }
+.lx-install > span { color: var(--vp-c-brand-1); }
+.vp-doc .lx-install code { color: var(--vp-c-text-1); background: transparent; font-size: 12px; overflow-x: auto; padding: 0; white-space: nowrap; }
+.lx-install button { font-size: 10px; padding: 3px 8px; border: 1px solid var(--vp-c-divider); border-radius: 5px; margin-left: auto; }
+.vp-doc .lx-caption { font-size: 11px; color: var(--vp-c-text-2); margin-top: 7px; }
+.lx-actions { display: flex; flex-wrap: wrap; gap: 10px; margin-top: 24px; }
+.vp-doc .lx-button { border-radius: 7px; font-size: 13px; padding: 8px 17px; text-decoration: none; font-weight: 550; }
+.lx-button.primary { background: #0b7f6b; color: white; }
+.lx-button.primary:hover { background: #096b5a; }
+.lx-button.secondary { border: 1px solid var(--vp-c-divider); color: var(--vp-c-text-1); }
+.lx-feature-grid { display: grid; grid-template-columns: 1fr 1fr; gap: 0 28px; margin: 15px 0 30px; }
+.lx-feature { padding: 20px 0; border-bottom: 1px solid var(--vp-c-divider); }
+.lx-feature strong { font-size: 14px; }
+.vp-doc .lx-feature p { color: var(--vp-c-text-2); font-size: 13px; line-height: 1.75; margin: 8px 0 0; }
+.lx-demo { border: 1px solid var(--vp-c-divider); border-radius: 12px; overflow: hidden; margin: 28px 0 20px; background: var(--vp-c-bg-soft); box-shadow: 0 12px 40px -20px rgba(0, 0, 0, .2); }
+.lx-demo-bar, .lx-demo-footer { display: flex; align-items: center; justify-content: space-between; gap: 12px; padding: 10px 14px; font-size: 10px; color: var(--vp-c-text-2); }
+.lx-demo-bar { border-bottom: 1px solid var(--vp-c-divider); }
+.lx-demo-bar span:first-child { letter-spacing: 1px; font-weight: 600; }
+.lx-demo-bar i { display: inline-block; width: 5px; height: 5px; background: #18b69b; border-radius: 50%; margin-right: 5px; vertical-align: middle; }
+.lx-demo iframe { display: block; width: 100%; height: 600px; border: 0; background: var(--vp-c-bg); }
+.lx-demo-footer { border-top: 1px solid var(--vp-c-divider); }
+.lx-demo-footer a { white-space: nowrap; }
+@media (min-width: 1280px) { .VPDoc.has-aside .content-container { max-width: 760px; } }
+@media (max-width: 640px) {
+  .lx-feature-grid { grid-template-columns: 1fr; }
+  .vp-doc .lx-lead { font-size: 16px; }
+  .lx-demo iframe { height: 700px; }
+  .lx-demo-bar span:last-child, .lx-demo-footer span { display: none; }
+  .lx-demo-footer { justify-content: flex-end; }
+}

laranex_schema_viewer-0.1.0/.gh-page/.vitepress/theme/index.ts

@@ -0,0 +1,14 @@
+import '@fontsource-variable/geist'
+import '@fontsource-variable/geist-mono'
+import DefaultTheme from 'vitepress/theme'
+import PackageIntroduction from './PackageIntroduction.vue'
+import LiveDemo from './LiveDemo.vue'
+import './custom.css'
+
+export default {
+  extends: DefaultTheme,
+  enhanceApp({ app }) {
+    app.component('PackageIntroduction', PackageIntroduction)
+    app.component('LiveDemo', LiveDemo)
+  },
+}

laranex_schema_viewer-0.1.0/.gh-page/demo/schema.mjs

@@ -0,0 +1,76 @@
+// Entirely synthetic project workspace. Never import application/reference metadata.
+const tid = name => `demo:${name}`;
+const mid = name => `model:${name}`;
+const col = (name, type = 'INTEGER', options = {}) => ({
+    name, type, timezone: null, nullable: false, primary_key: name === 'id',
+    autoincrement: 'auto', default: null, server_default: null, comment: null, ...options,
+});
+const fk = (table, column, target) => ({
+    id: `fk:${table}:${column}`, name: `fk_${table}_${column}`, columns: [column],
+    target_table: tid(target), target_columns: ['id'], on_delete: 'RESTRICT',
+    on_update: null, deferrable: null, initially: null,
+});
+const index = (name, columns, unique = false, options = {}) => ({
+    name, columns, expressions: [...columns], unique, predicates: {}, included_columns: {}, methods: {}, ...options,
+});
+const table = (name, columns, foreign_keys = [], indexes = []) => ({
+    id: tid(name), namespace: 'workspace', name, schema_name: null,
+    comment: 'Synthetic public documentation example', columns: [col('id'), ...columns],
+    primary_key: ['id'], indexes, foreign_keys, constraints: [],
+});
+const pair = (localTable, localColumn, remoteTable, remoteColumn) => ({
+    local: {table: tid(localTable), column: localColumn},
+    remote: {table: tid(remoteTable), column: remoteColumn},
+});
+function relation(source, name, target, direction, join_pairs, secondary = null) {
+    return {
+        id: `orm:${source}:${name}`, name, model: mid(source), target_model: mid(target),
+        source_table: tid(source), target_table: tid(target), direction,
+        uselist: direction !== 'MANYTOONE', viewonly: false, back_populates: null,
+        secondary: secondary ? tid(secondary) : null,
+        primary_join: join_pairs.map(p => `${p.local.table}.${p.local.column} = ${p.remote.table}.${p.remote.column}`).join(' AND '),
+        secondary_join: secondary ? `${secondary}.${target.slice(0, -1)}_id = ${target}.id` : null,
+        join_pairs,
+    };
+}
+
+export const schema = {
+    format: 'laranex-schema-viewer', version: 1, scope: 'declared_metadata',
+    tables: [
+        table('users', [col('email', 'VARCHAR(254)'), col('manager_id', 'INTEGER', {nullable: true}), col('active', 'BOOLEAN')],
+            [fk('users', 'manager_id', 'users')],
+            [index('uq_users_active_email', ['email'], true, {predicates: {postgresql: 'active = true'}})]),
+        table('teams', [col('name', 'VARCHAR(100)')]),
+        table('team_members', [col('user_id'), col('team_id')],
+            [fk('team_members', 'user_id', 'users'), fk('team_members', 'team_id', 'teams')],
+            [index('uq_team_members_pair', ['team_id', 'user_id'], true)]),
+        table('projects', [col('name', 'VARCHAR(120)'), col('owner_id'), col('team_id')],
+            [fk('projects', 'owner_id', 'users'), fk('projects', 'team_id', 'teams')]),
+        table('tasks', [col('title', 'VARCHAR(200)'), col('project_id'), col('assignee_id'), col('parent_id', 'INTEGER', {nullable: true}), col('metadata', 'JSONB')],
+            [fk('tasks', 'project_id', 'projects'), fk('tasks', 'assignee_id', 'users'), fk('tasks', 'parent_id', 'tasks')],
+            [index('ix_tasks_project', ['project_id']), index('ix_tasks_lower_title', [], false, {expressions: ['lower(title)']})]),
+        table('comments', [col('body', 'TEXT'), col('task_id'), col('user_id')],
+            [fk('comments', 'task_id', 'tasks'), fk('comments', 'user_id', 'users')]),
+        table('tags', [col('name', 'VARCHAR(40)')]),
+        table('task_tags', [col('task_id'), col('tag_id')],
+            [fk('task_tags', 'task_id', 'tasks'), fk('task_tags', 'tag_id', 'tags')]),
+        table('audit_events', [col('actor_id'), col('event', 'VARCHAR(80)'), col('created_at', 'DATETIME', {timezone: true})],
+            [fk('audit_events', 'actor_id', 'users')]),
+    ],
+    models: ['users', 'teams', 'projects', 'tasks', 'comments', 'tags'].map(name => ({
+        id: mid(name), class_name: `demo.models.${name.split('_').map(s => s[0].toUpperCase() + s.slice(1)).join('')}Model`,
+        table_ids: [tid(name)], primary_key: ['id'], source: null,
+    })),
+    relationships: [
+        relation('users', 'manager', 'users', 'MANYTOONE', [pair('users', 'manager_id', 'users', 'id')]),
+        relation('users', 'teams', 'teams', 'MANYTOMANY', [pair('users', 'id', 'team_members', 'user_id'), pair('teams', 'id', 'team_members', 'team_id')], 'team_members'),
+        relation('teams', 'members', 'users', 'MANYTOMANY', [pair('teams', 'id', 'team_members', 'team_id'), pair('users', 'id', 'team_members', 'user_id')], 'team_members'),
+        relation('projects', 'tasks', 'tasks', 'ONETOMANY', [pair('projects', 'id', 'tasks', 'project_id')]),
+        relation('tasks', 'project', 'projects', 'MANYTOONE', [pair('tasks', 'project_id', 'projects', 'id')]),
+        relation('tasks', 'assignee', 'users', 'MANYTOONE', [pair('tasks', 'assignee_id', 'users', 'id')]),
+        relation('tasks', 'comments', 'comments', 'ONETOMANY', [pair('tasks', 'id', 'comments', 'task_id')]),
+        relation('comments', 'task', 'tasks', 'MANYTOONE', [pair('comments', 'task_id', 'tasks', 'id')]),
+        relation('tasks', 'tags', 'tags', 'MANYTOMANY', [pair('tasks', 'id', 'task_tags', 'task_id'), pair('tags', 'id', 'task_tags', 'tag_id')], 'task_tags'),
+    ],
+    diagnostics: [],
+};