plainkitbin-sqlitemd 1.0.0__py3-none-any.whl

plainkitbin_sqlitemd-1.0.0.dist-info/METADATA

@@ -0,0 +1,90 @@
+Metadata-Version: 2.4
+Name: plainkitbin-sqlitemd
+Version: 1.0.0
+Summary: Offline SQLite schema exporter for LLM context. Stdlib only, no network at runtime.
+Author: PlainKitBin
+License: MIT License
+        
+        Copyright (c) 2026 PlainKitBin
+        
+        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.
+        
+        GOVERNING LAW
+        This Agreement shall be governed by and construed in accordance with the laws of Japan.
+        
+        EXPORT COMPLIANCE
+        You agree to comply with all applicable export and import laws and regulations. The product must not be exported to embargoed countries or sanctioned individuals.
+        
+        ACCEPTABLE USE
+        You agree not to use the product for any unlawful, illegal, or malicious activities.
+        
+        SEVERABILITY
+        If any provision of this license is held to be invalid or unenforceable, the remaining provisions shall remain in full force and effect.
+        
+Project-URL: Homepage, https://plainkitbin.gumroad.com
+Project-URL: Source, https://github.com/plainkitbin/sqlitemd
+Keywords: sqlite,schema,markdown,cli,offline
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Environment :: Console
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# SQLiteMD
+
+Export a SQLite schema to Markdown for LLM context -- offline, no
+dependencies. Python 3.8+, stdlib only (`sqlite3`). No network at
+runtime.
+
+## Usage
+
+```bash
+python3 sqlitemd.py export my.db -o schema.md
+python3 sqlitemd.py schema my.db -o schema.json
+```
+
+## CRON example
+
+```bash
+# Weekly schema doc for a local analytics db
+0 3 * * 0 cd /path/to/sqlitemd && python3 sqlitemd.py export /data/app.db -o /backup/schema.md
+```
+
+## Limitations
+
+Read-only introspection. Does not migrate data. Complex
+attached databases are not supported.
+
+Free and open source (MIT license, see LICENSE). No telemetry, no
+network calls, no nagware.
+
+Part of the [PlainKitBin](https://plainkitbin.gumroad.com) toolset --
+small, offline, single-file utilities with automated tests and a
+provenance record for every release. If you find this useful, check out
+[PlainKitBin DirSnapshot](https://plainkitbin.gumroad.com/l/PlainKitBinDirSnapshot).
+
+Provided as-is with no individual support.
+
+
+---
+*Built with AI assistance and automatically tested before release; released under human oversight.*

plainkitbin_sqlitemd-1.0.0.dist-info/RECORD

@@ -0,0 +1,7 @@
+sqlitemd.py,sha256=iIDwZK1Oq8_37EdYNZfOUDFwq9wPOPuxfMNGLPI6TGQ,3721
+plainkitbin_sqlitemd-1.0.0.dist-info/licenses/LICENSE,sha256=V59rRQ8oTck6lR7J0APsOgdv8Vh6NtRji6mjof_GAE4,1605
+plainkitbin_sqlitemd-1.0.0.dist-info/METADATA,sha256=eYYT4LctExdNM8w_438yTBna-IMNjcwxKxzCbUiiCd4,3602
+plainkitbin_sqlitemd-1.0.0.dist-info/WHEEL,sha256=K260EYznzXsJYBQGqmI8VTxEdiZYNvDZwW9cBh9-_MA,91
+plainkitbin_sqlitemd-1.0.0.dist-info/entry_points.txt,sha256=7wR1BvwXOl8ANCIDYto_o-F3xfn7JoSVgsP6SlXZMQU,43
+plainkitbin_sqlitemd-1.0.0.dist-info/top_level.txt,sha256=kGyMIKlOwLUDTApEsn1n4f9uZPPq8McplUHE3Ek9ZD8,9
+plainkitbin_sqlitemd-1.0.0.dist-info/RECORD,,

plainkitbin_sqlitemd-1.0.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (83.0.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

plainkitbin_sqlitemd-1.0.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+sqlitemd = sqlitemd:main

plainkitbin_sqlitemd-1.0.0.dist-info/licenses/LICENSE

@@ -0,0 +1,34 @@
+MIT License
+
+Copyright (c) 2026 PlainKitBin
+
+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.
+
+GOVERNING LAW
+This Agreement shall be governed by and construed in accordance with the laws of Japan.
+
+EXPORT COMPLIANCE
+You agree to comply with all applicable export and import laws and regulations. The product must not be exported to embargoed countries or sanctioned individuals.
+
+ACCEPTABLE USE
+You agree not to use the product for any unlawful, illegal, or malicious activities.
+
+SEVERABILITY
+If any provision of this license is held to be invalid or unenforceable, the remaining provisions shall remain in full force and effect.

plainkitbin_sqlitemd-1.0.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+sqlitemd

sqlitemd.py

@@ -0,0 +1,130 @@
+#!/usr/bin/env python3
+# MIT License
+# Copyright (c) 2026 PlainKitBin
+#
+# SQLite schema -> Markdown exporter. Stdlib only. Product #2.
+import argparse
+import os
+import sqlite3
+import sys
+
+_HDR = "# SQLite Schema\n\n"
+
+
+def _ro_conn(db_path):
+    uri = "file:" + os.path.abspath(db_path) + "?mode=ro"
+    return sqlite3.connect(uri, uri=True)
+
+
+def introspect_db(db_path):
+    """Return sorted schema dict from a sqlite database."""
+    if not os.path.isfile(db_path):
+        raise ValueError("db missing: " + db_path)
+    conn = _ro_conn(db_path)
+    try:
+        cur = conn.cursor()
+        sql = (
+            "SELECT name FROM sqlite_master "
+            "WHERE type='table' AND name NOT LIKE 'sqlite_%' "
+            "ORDER BY name"
+        )
+        names = [r[0] for r in cur.execute(sql).fetchall()]
+        tables = []
+        for name in names:
+            cols = cur.execute(
+                "PRAGMA table_info(" + name + ")"
+            ).fetchall()
+            idx = cur.execute(
+                "PRAGMA index_list(" + name + ")"
+            ).fetchall()
+            rows = []
+            for r in cols:
+                rows.append({
+                    "name": r[1],
+                    "type": r[2] or "",
+                    "notnull": bool(r[3]),
+                    "pk": bool(r[5]),
+                })
+            tables.append({
+                "name": name,
+                "columns": rows,
+                "index_count": len(idx),
+            })
+        return {"tables": tables}
+    finally:
+        conn.close()
+
+
+def schema_to_markdown(schema):
+    """Pure: schema dict -> markdown string."""
+    lines = [_HDR.rstrip(), ""]
+    for tbl in schema.get("tables", []):
+        lines.append("## " + tbl["name"])
+        lines.append("")
+        lines.append("| column | type | pk | notnull |")
+        lines.append("| --- | --- | --- | --- |")
+        for c in tbl["columns"]:
+            pk = "yes" if c["pk"] else ""
+            nn = "yes" if c["notnull"] else ""
+            nm = c["name"]
+            ty = c["type"]
+            lines.append(
+                "| " + nm + " | " + ty + " | " + pk + " | " + nn + " |"
+            )
+        lines.append("")
+        ic = tbl.get("index_count", 0)
+        lines.append("Indexes: " + str(ic))
+        lines.append("")
+    return "\n".join(lines).rstrip() + "\n"
+
+
+def export_markdown(db_path):
+    """Pure pipeline: db path -> markdown string."""
+    return schema_to_markdown(introspect_db(db_path))
+
+
+def _cmd_export(args):
+    md = export_markdown(args.db)
+    if args.out:
+        with open(args.out, "w", encoding="utf-8") as f:
+            f.write(md)
+    else:
+        sys.stdout.write(md)
+    return 0
+
+
+def _cmd_schema(args):
+    import json
+    data = introspect_db(args.db)
+    txt = json.dumps(data, indent=2, sort_keys=True) + "\n"
+    if args.out:
+        with open(args.out, "w", encoding="utf-8") as f:
+            f.write(txt)
+    else:
+        sys.stdout.write(txt)
+    return 0
+
+
+def main(argv=None):
+    p = argparse.ArgumentParser(
+        description="SQLite schema to Markdown (offline)",
+    )
+    sub = p.add_subparsers(dest="cmd", required=True)
+    pe = sub.add_parser("export", help="write markdown report")
+    pe.add_argument("db")
+    pe.add_argument("-o", "--out", default="")
+    pe.set_defaults(func=_cmd_export)
+    ps = sub.add_parser("schema", help="write json schema")
+    ps.add_argument("db")
+    ps.add_argument("-o", "--out", default="")
+    ps.set_defaults(func=_cmd_schema)
+    args = p.parse_args(argv)
+    try:
+        return args.func(args)
+    except (OSError, ValueError, sqlite3.Error) as e:
+        print("error:", e, file=sys.stderr)
+        return 1
+
+
+if __name__ == "__main__":
+    sys.exit(main())