sqlmodel-ext 0.3.0__tar.gz → 0.3.2__tar.gz

{sqlmodel_ext-0.3.0 → sqlmodel_ext-0.3.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sqlmodel-ext
-Version: 0.3.0
+Version: 0.3.2
 Summary: Extended SQLModel infrastructure: smart metaclass, async CRUD mixins, polymorphic inheritance, optimistic locking, relation preloading, and reusable field types.
 Project-URL: Homepage, https://github.com/Foxerine/sqlmodel-ext
 Project-URL: Repository, https://github.com/Foxerine/sqlmodel-ext

sqlmodel_ext-0.3.2/docs/.vitepress/config.mts

@@ -0,0 +1,57 @@
+import { withMermaid } from 'vitepress-plugin-mermaid'
+import llmstxt from 'vitepress-plugin-llms'
+import { copyOrDownloadAsMarkdownButtons } from 'vitepress-plugin-llms'
+import { zh } from './zh.mts'
+import { en } from './en.mts'
+
+export default withMermaid({
+  title: 'sqlmodel-ext',
+
+  vite: {
+    plugins: [
+      llmstxt({
+        // Exclude legacy redirect placeholders. The old guide/internals trees were
+        // migrated to tutorials/how-to/reference/explanation under Diátaxis;
+        // the placeholders only carry meta-refresh stubs and would pollute llms-full.txt.
+        ignoreFiles: [
+          'guide/*',
+          'internals/*',
+          'en/guide/*',
+          'en/internals/*',
+        ],
+      }),
+    ],
+    optimizeDeps: {
+      include: ['mermaid', 'dayjs'],
+    },
+    ssr: {
+      noExternal: ['vitepress-plugin-mermaid', 'mermaid'],
+    },
+  },
+
+  markdown: {
+    config(md) {
+      md.use(copyOrDownloadAsMarkdownButtons)
+    },
+  },
+
+  locales: {
+    root: {
+      label: '简体中文',
+      ...zh,
+    },
+    en: {
+      label: 'English',
+      ...en,
+    },
+  },
+
+  themeConfig: {
+    socialLinks: [
+      { icon: 'github', link: 'https://github.com/Foxerine/sqlmodel-ext' },
+    ],
+    search: {
+      provider: 'local',
+    },
+  },
+})

sqlmodel_ext-0.3.2/docs/.vitepress/en.mts

@@ -0,0 +1,88 @@
+import type { DefaultTheme } from 'vitepress'
+
+export const en = {
+  lang: 'en',
+  description: 'SQLModel Enhancement Library — Tutorials, How-to, Reference, Explanation',
+
+  themeConfig: {
+    nav: [
+      { text: 'Home', link: '/en/' },
+      { text: 'Tutorials', link: '/en/tutorials/' },
+      { text: 'How-to', link: '/en/how-to/' },
+      { text: 'Reference', link: '/en/reference/' },
+      { text: 'Explanation', link: '/en/explanation/' },
+    ],
+
+    sidebar: {
+      '/en/tutorials/': [
+        {
+          text: 'Tutorials',
+          items: [
+            { text: 'Overview', link: '/en/tutorials/' },
+            { text: '01 · Getting started', link: '/en/tutorials/01-getting-started' },
+            { text: '02 · Building a blog API', link: '/en/tutorials/02-building-a-blog-api' },
+            { text: '03 · Adding Redis caching', link: '/en/tutorials/03-adding-redis-cache' },
+          ],
+        },
+      ],
+      '/en/how-to/': [
+        {
+          text: 'How-to guides',
+          items: [
+            { text: 'Overview', link: '/en/how-to/' },
+            { text: 'Integrate with FastAPI', link: '/en/how-to/integrate-with-fastapi' },
+            { text: 'Paginate a list endpoint', link: '/en/how-to/paginate-a-list-endpoint' },
+            { text: 'Define JTI models', link: '/en/how-to/define-jti-models' },
+            { text: 'Define STI models', link: '/en/how-to/define-sti-models' },
+            { text: 'Handle concurrent updates', link: '/en/how-to/handle-concurrent-updates' },
+            { text: 'Prevent MissingGreenlet errors', link: '/en/how-to/prevent-missing-greenlet' },
+            { text: 'Release the DB connection during long I/O', link: '/en/how-to/release-connection-during-long-io' },
+            { text: 'Configure cascade delete', link: '/en/how-to/configure-cascade-delete' },
+            { text: 'Cache queries with Redis', link: '/en/how-to/cache-queries' },
+          ],
+        },
+      ],
+      '/en/reference/': [
+        {
+          text: 'Reference',
+          items: [
+            { text: 'Overview', link: '/en/reference/' },
+            { text: 'Base classes', link: '/en/reference/base-classes' },
+            { text: 'CRUD methods', link: '/en/reference/crud-methods' },
+            { text: 'Field types', link: '/en/reference/field-types' },
+            { text: 'Mixins', link: '/en/reference/mixins' },
+            { text: 'Decorators & helpers', link: '/en/reference/decorators' },
+            { text: 'Pagination types', link: '/en/reference/pagination-types' },
+          ],
+        },
+      ],
+      '/en/explanation/': [
+        {
+          text: 'Explanation',
+          items: [
+            { text: 'Overview', link: '/en/explanation/' },
+            { text: 'Prerequisites', link: '/en/explanation/prerequisites' },
+            { text: 'Metaclass & SQLModelBase', link: '/en/explanation/metaclass' },
+            { text: 'CRUD pipeline', link: '/en/explanation/crud-pipeline' },
+            { text: 'Polymorphic internals', link: '/en/explanation/polymorphic-internals' },
+            { text: 'Optimistic locking', link: '/en/explanation/optimistic-lock' },
+            { text: 'Relation preloading', link: '/en/explanation/relation-preload' },
+            { text: 'Cascade delete semantics', link: '/en/explanation/cascade-delete-semantics' },
+            { text: 'Redis caching', link: '/en/explanation/cached-table' },
+            { text: 'Static analyzer', link: '/en/explanation/relation-load-checker' },
+          ],
+        },
+      ],
+    },
+
+    outline: {
+      level: [2, 3],
+      label: 'On this page',
+    },
+
+    docFooter: {
+      prev: 'Previous',
+      next: 'Next',
+    },
+  } satisfies DefaultTheme.Config,
+}

sqlmodel_ext-0.3.2/docs/.vitepress/theme/index.ts

@@ -0,0 +1,13 @@
+// .vitepress/theme/index.ts
+import DefaultTheme from 'vitepress/theme'
+import type { Theme } from 'vitepress'
+import CopyOrDownloadAsMarkdownButtons from 'vitepress-plugin-llms/vitepress-components/CopyOrDownloadAsMarkdownButtons.vue'
+import '@fontsource/maple-mono';
+import './style/custom.css'
+
+export default {
+    extends: DefaultTheme,
+    enhanceApp({ app }) {
+      app.component('CopyOrDownloadAsMarkdownButtons', CopyOrDownloadAsMarkdownButtons)
+    },
+  } satisfies Theme

sqlmodel_ext-0.3.2/docs/.vitepress/zh.mts

@@ -0,0 +1,88 @@
+import type { DefaultTheme } from 'vitepress'
+
+export const zh = {
+  lang: 'zh-CN',
+  description: 'SQLModel 增强库 — 教程、操作指南、参考、讲解',
+
+  themeConfig: {
+    nav: [
+      { text: '首页', link: '/' },
+      { text: '教程', link: '/tutorials/' },
+      { text: '操作指南', link: '/how-to/' },
+      { text: '参考', link: '/reference/' },
+      { text: '讲解', link: '/explanation/' },
+    ],
+
+    sidebar: {
+      '/tutorials/': [
+        {
+          text: '教程',
+          items: [
+            { text: '总览', link: '/tutorials/' },
+            { text: '01 · 快速上手', link: '/tutorials/01-getting-started' },
+            { text: '02 · 构建博客 API', link: '/tutorials/02-building-a-blog-api' },
+            { text: '03 · 给博客加 Redis 缓存', link: '/tutorials/03-adding-redis-cache' },
+          ],
+        },
+      ],
+      '/how-to/': [
+        {
+          text: '操作指南',
+          items: [
+            { text: '总览', link: '/how-to/' },
+            { text: '集成 FastAPI', link: '/how-to/integrate-with-fastapi' },
+            { text: '给列表端点加分页', link: '/how-to/paginate-a-list-endpoint' },
+            { text: '定义 JTI 联表继承模型', link: '/how-to/define-jti-models' },
+            { text: '定义 STI 单表继承模型', link: '/how-to/define-sti-models' },
+            { text: '处理并发更新', link: '/how-to/handle-concurrent-updates' },
+            { text: '防止 MissingGreenlet 错误', link: '/how-to/prevent-missing-greenlet' },
+            { text: '长 I/O 期间释放数据库连接', link: '/how-to/release-connection-during-long-io' },
+            { text: '配置级联删除', link: '/how-to/configure-cascade-delete' },
+            { text: '给查询加 Redis 缓存', link: '/how-to/cache-queries' },
+          ],
+        },
+      ],
+      '/reference/': [
+        {
+          text: '参考',
+          items: [
+            { text: '总览', link: '/reference/' },
+            { text: '基础类', link: '/reference/base-classes' },
+            { text: 'CRUD 方法', link: '/reference/crud-methods' },
+            { text: '字段类型', link: '/reference/field-types' },
+            { text: 'Mixin 类', link: '/reference/mixins' },
+            { text: '装饰器与辅助函数', link: '/reference/decorators' },
+            { text: '分页类型', link: '/reference/pagination-types' },
+          ],
+        },
+      ],
+      '/explanation/': [
+        {
+          text: '讲解',
+          items: [
+            { text: '总览', link: '/explanation/' },
+            { text: '前置知识', link: '/explanation/prerequisites' },
+            { text: '元类与 SQLModelBase', link: '/explanation/metaclass' },
+            { text: 'CRUD 实现', link: '/explanation/crud-pipeline' },
+            { text: '多态继承机制', link: '/explanation/polymorphic-internals' },
+            { text: '乐观锁机制', link: '/explanation/optimistic-lock' },
+            { text: '关系预加载机制', link: '/explanation/relation-preload' },
+            { text: '级联删除语义', link: '/explanation/cascade-delete-semantics' },
+            { text: 'Redis 缓存机制', link: '/explanation/cached-table' },
+            { text: '静态分析器原理', link: '/explanation/relation-load-checker' },
+          ],
+        },
+      ],
+    },
+
+    outline: {
+      level: [2, 3],
+      label: '目录',
+    },
+
+    docFooter: {
+      prev: '上一页',
+      next: '下一页',
+    },
+  } satisfies DefaultTheme.Config,
+}