erdalchemy 0.1.0__py3-none-any.whl

erdalchemy-0.1.0.dist-info/METADATA

@@ -0,0 +1,153 @@
+Metadata-Version: 2.4
+Name: erdalchemy
+Version: 0.1.0
+Summary: Interactive ERD visualization for SQLAlchemy 2.0 models
+Author: Jose Velazco
+License-Expression: MIT
+License-File: LICENSE
+Keywords: database,diagram,erd,sqlalchemy,visualization
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Database
+Classifier: Topic :: Software Development :: Documentation
+Requires-Python: >=3.10
+Requires-Dist: sqlalchemy>=2.0
+Provides-Extra: all
+Requires-Dist: cairosvg>=2.7; extra == 'all'
+Provides-Extra: pdf
+Requires-Dist: cairosvg>=2.7; extra == 'pdf'
+Provides-Extra: png
+Requires-Dist: cairosvg>=2.7; extra == 'png'
+Description-Content-Type: text/markdown
+
+# sqlalchemy-erd
+
+Interactive ERD visualizer for SQLAlchemy 2.0 models. Introspects your `DeclarativeBase` metadata and generates diagram files with no manual configuration required.
+
+- Drag-and-drop interactive HTML output
+- Auto-layout via force-directed algorithm
+- Hover highlighting for tables and relationships
+- Export to HTML, SVG, PNG, and PDF
+- Built-in color themes and per-table color overrides
+- Zero dependencies beyond SQLAlchemy
+
+![preview](examples/blog/blog.png)
+
+## Installation
+
+```bash
+pip install sqlalchemy-erd
+```
+
+PNG and PDF export require an optional dependency:
+
+```bash
+pip install "sqlalchemy-erd[all]"
+```
+
+## Quick start
+
+```python
+from sqlalchemy_erd import generate_erd
+from myapp.models import Base
+
+generate_erd(Base, output="erd.html")
+```
+
+## CLI
+
+```bash
+# Interactive HTML (default)
+sqlalchemy-erd myapp.models:Base
+
+# Specific format and output path
+sqlalchemy-erd myapp.models:Base --format svg --output erd.svg
+
+# With theme and custom title
+sqlalchemy-erd myapp.models:Base --format png --theme blue --title "My Schema"
+
+# Per-table color overrides as JSON
+sqlalchemy-erd myapp.models:Base --colors '{"users": "#1d4ed8", "orders": "#059669"}'
+
+# High-resolution PNG
+sqlalchemy-erd myapp.models:Base --format png --scale 3
+```
+
+## Python API
+
+```python
+from sqlalchemy_erd import generate_erd
+from myapp.models import Base
+
+generate_erd(Base, output="erd.html", format="html")
+generate_erd(Base, output="erd.svg",  format="svg")
+generate_erd(Base, output="erd.png",  format="png", scale=2)   # requires cairosvg
+generate_erd(Base, output="erd.pdf",  format="pdf")             # requires cairosvg
+```
+
+## Themes
+
+Five built-in themes: `default`, `blue`, `green`, `dark`, `rose`.
+
+Preview images for each theme are available in [`examples/themes/`](examples/themes/).
+
+```python
+generate_erd(Base, theme="dark")
+```
+
+Per-table color overrides let you assign any hex color to individual tables while keeping the rest of the theme intact:
+
+```python
+generate_erd(
+    Base,
+    theme="default",
+    table_colors={
+        "users":    "#1e40af",
+        "orders":   "#065f46",
+        "products": "#9f1239",
+    },
+)
+```
+
+## Supported column types
+
+| SQLAlchemy type | Badge |
+|---|---|
+| Primary key | `PK` |
+| Foreign key | `FK` |
+| `String` | `string` |
+| `Text` | `text` |
+| `Integer` / `BigInteger` / `SmallInteger` | `int` / `bigint` / `smallint` |
+| `Float` / `Numeric` | `float` / `numeric` |
+| `Date` | `date` |
+| `DateTime` | `datetime` |
+| `Boolean` | `bool` |
+| `JSON` | `json` |
+| `Uuid` | `uuid` |
+
+Nullable columns display a `?` suffix (e.g. `text?`, `date?`).
+
+## Relationship types
+
+| Cardinality | Line style |
+|---|---|
+| 1:N | Solid with arrow |
+| N:N | Dashed with arrow |
+
+## Examples
+
+See the [`examples/`](examples/) directory:
+
+- [`examples/blog/`](examples/blog/) - blog schema (User, Post, Comment)
+- [`examples/ecommerce/`](examples/ecommerce/) - 1:N chains (Category, Product, Order, Customer, OrderItem)
+- [`examples/university/`](examples/university/) - N:N via association tables (Student, Course, Professor, Department)
+- [`examples/hr/`](examples/hr/) - 1:1 and 1:N (Employee, EmployeeProfile, Department, Project)
+
+## License
+
+MIT

erdalchemy-0.1.0.dist-info/RECORD

@@ -0,0 +1,13 @@
+sqlalchemy_erd/__init__.py,sha256=9mRod1ez4p9RLjI19Wbo4zcWxW8CZutPngfna9evEoM,1773
+sqlalchemy_erd/cli.py,sha256=uGzOPLQ-COqH1EoUxPBTkwwiD_YaV-c0pdWbh9Z1bW0,3762
+sqlalchemy_erd/export.py,sha256=4GfKLKx9ASERNFbFskyPkl54-Ur7TmLQ8ODlDNNRpio,1912
+sqlalchemy_erd/html_renderer.py,sha256=PJzsVB-tQobTGGjV_hsnv6fG65OmxxtOsqnY1K9l98E,14891
+sqlalchemy_erd/introspect.py,sha256=zw8FohfvcPoCIuN5nfGKFSNzhwF6PapFasoPam-4XQE,4458
+sqlalchemy_erd/layout.py,sha256=jFr-OifD-REwKuDWDyDgS8hG6R-wMyopuM2QUnYNPto,3023
+sqlalchemy_erd/renderer.py,sha256=MP8xGpH9d1aL9I-PDrK_RvmE5Xdd5A2ct7-GFBW1OAk,7808
+sqlalchemy_erd/theme.py,sha256=30cPGZCCr81yn6zsNpCofrEwGqNEp-dhRER4B3mhFLA,2979
+erdalchemy-0.1.0.dist-info/METADATA,sha256=BSx70KrDjEUM0NL41Q-qmipvUhTAMP2gKddBxNVvRMw,4166
+erdalchemy-0.1.0.dist-info/WHEEL,sha256=QccIxa26bgl1E6uMy58deGWi-0aeIkkangHcxk2kWfw,87
+erdalchemy-0.1.0.dist-info/entry_points.txt,sha256=hHf4RHtS89nkNHpee5w8xWYxVZh-Z4EwkfzNGGAtZW0,59
+erdalchemy-0.1.0.dist-info/licenses/LICENSE,sha256=pCDEr9PXBYS-kebMYd19au89zccgIo88pgRXnNwv618,1069
+erdalchemy-0.1.0.dist-info/RECORD,,

erdalchemy-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.29.0
+Root-Is-Purelib: true
+Tag: py3-none-any

erdalchemy-0.1.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+sqlalchemy-erd = sqlalchemy_erd.cli:main

erdalchemy-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Jose Velazco
+
+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.

sqlalchemy_erd/__init__.py

@@ -0,0 +1,49 @@
+"""sqlalchemy-erd: Interactive ERD visualization for SQLAlchemy 2.0 models."""
+
+from __future__ import annotations
+
+from pathlib import Path
+from typing import Union
+
+from sqlalchemy import MetaData
+from sqlalchemy.orm import DeclarativeBase
+
+from sqlalchemy_erd.introspect import introspect_models
+from sqlalchemy_erd.layout import force_directed_layout
+from sqlalchemy_erd.theme import Theme, THEMES, get_theme
+from sqlalchemy_erd.export import to_html, to_svg, to_png, to_pdf
+
+__version__ = "0.1.0"
+
+
+def generate_erd(
+    base_or_metadata: Union[type[DeclarativeBase], MetaData],
+    output: str = "erd.html",
+    format: str = "html",
+    theme: Union[str, Theme] = "default",
+    table_colors: dict[str, str] | None = None,
+    title: str = "ERD",
+    scale: int = 2,
+) -> Union[str, bytes]:
+    tables, relationships = introspect_models(base_or_metadata)
+    resolved_theme = get_theme(theme, table_colors)
+    positions = force_directed_layout(tables, relationships)
+
+    if format == "html":
+        content = to_html(tables, relationships, positions, resolved_theme, title=title)
+        Path(output).write_text(content, encoding="utf-8")
+        return content
+    elif format == "svg":
+        content = to_svg(tables, relationships, positions, resolved_theme)
+        Path(output).write_text(content, encoding="utf-8")
+        return content
+    elif format == "png":
+        data = to_png(tables, relationships, positions, resolved_theme, scale=scale)
+        Path(output).write_bytes(data)
+        return data
+    elif format == "pdf":
+        data = to_pdf(tables, relationships, positions, resolved_theme)
+        Path(output).write_bytes(data)
+        return data
+    else:
+        raise ValueError(f"Unknown format '{format}'. Use: html, svg, png, pdf")

sqlalchemy_erd/cli.py

@@ -0,0 +1,123 @@
+from __future__ import annotations
+
+import argparse
+import importlib
+import json
+import sys
+from pathlib import Path
+
+from sqlalchemy.orm import DeclarativeBase
+from sqlalchemy import MetaData
+
+from sqlalchemy_erd.introspect import introspect_models
+from sqlalchemy_erd.layout import force_directed_layout
+from sqlalchemy_erd.theme import get_theme, THEMES
+from sqlalchemy_erd.export import to_svg, to_html, to_png, to_pdf
+
+
+def _resolve_target(spec: str) -> type[DeclarativeBase] | MetaData:
+    if ":" in spec:
+        module_path, attr_name = spec.rsplit(":", 1)
+    else:
+        module_path = spec
+        attr_name = None
+
+    sys.path.insert(0, str(Path.cwd()))
+    module = importlib.import_module(module_path)
+
+    if attr_name:
+        obj = getattr(module, attr_name)
+    else:
+        obj = None
+        for name in dir(module):
+            val = getattr(module, name)
+            if isinstance(val, type) and issubclass(val, DeclarativeBase) and val is not DeclarativeBase:
+                obj = val
+                break
+        if obj is None:
+            for name in dir(module):
+                val = getattr(module, name)
+                if isinstance(val, MetaData):
+                    obj = val
+                    break
+        if obj is None:
+            print(f"Error: no DeclarativeBase subclass or MetaData found in '{module_path}'", file=sys.stderr)
+            sys.exit(1)
+
+    return obj
+
+
+def main(argv: list[str] | None = None) -> None:
+    parser = argparse.ArgumentParser(
+        prog="sqlalchemy-erd",
+        description="Generate ERD diagrams from SQLAlchemy 2.0 models",
+    )
+    parser.add_argument(
+        "target",
+        help="Python import path to Base class (e.g., myapp.models:Base)",
+    )
+    parser.add_argument(
+        "-f", "--format",
+        choices=["html", "svg", "png", "pdf"],
+        default="html",
+        help="Output format (default: html)",
+    )
+    parser.add_argument(
+        "-o", "--output",
+        help="Output file path (default: erd.<format>)",
+    )
+    parser.add_argument(
+        "-t", "--theme",
+        choices=list(THEMES.keys()),
+        default="default",
+        help="Color theme (default: default)",
+    )
+    parser.add_argument(
+        "--colors",
+        help='Per-table color overrides as JSON: \'{"users": "#1d4ed8"}\'',
+    )
+    parser.add_argument(
+        "--scale",
+        type=int,
+        default=2,
+        help="Scale factor for PNG export (default: 2)",
+    )
+    parser.add_argument(
+        "--title",
+        default="ERD",
+        help="Title for HTML output (default: ERD)",
+    )
+
+    args = parser.parse_args(argv)
+
+    target = _resolve_target(args.target)
+    tables, relationships = introspect_models(target)
+
+    if not tables:
+        print("No tables found.", file=sys.stderr)
+        sys.exit(1)
+
+    table_colors = json.loads(args.colors) if args.colors else None
+    theme = get_theme(args.theme, table_colors)
+    positions = force_directed_layout(tables, relationships)
+
+    output_path = args.output or f"erd.{args.format}"
+
+    if args.format == "html":
+        content = to_html(tables, relationships, positions, theme, title=args.title)
+        Path(output_path).write_text(content, encoding="utf-8")
+    elif args.format == "svg":
+        content = to_svg(tables, relationships, positions, theme)
+        Path(output_path).write_text(content, encoding="utf-8")
+    elif args.format == "png":
+        data = to_png(tables, relationships, positions, theme, scale=args.scale)
+        Path(output_path).write_bytes(data)
+    elif args.format == "pdf":
+        data = to_pdf(tables, relationships, positions, theme)
+        Path(output_path).write_bytes(data)
+
+    print(f"Generated {output_path}")
+
+
+if __name__ == "__main__":
+    main()

sqlalchemy_erd/export.py

@@ -0,0 +1,63 @@
+from __future__ import annotations
+
+from pathlib import Path
+
+from sqlalchemy_erd.introspect import TableInfo, RelationshipInfo
+from sqlalchemy_erd.layout import force_directed_layout
+from sqlalchemy_erd.renderer import render_svg
+from sqlalchemy_erd.html_renderer import render_html
+from sqlalchemy_erd.theme import Theme
+
+
+def to_svg(
+    tables: list[TableInfo],
+    relationships: list[RelationshipInfo],
+    positions: dict[str, tuple[float, float]],
+    theme: Theme,
+) -> str:
+    return render_svg(tables, relationships, positions, theme, include_xml_header=True)
+
+
+def to_html(
+    tables: list[TableInfo],
+    relationships: list[RelationshipInfo],
+    positions: dict[str, tuple[float, float]],
+    theme: Theme,
+    title: str = "ERD",
+) -> str:
+    return render_html(tables, relationships, positions, theme, title=title)
+
+
+def to_png(
+    tables: list[TableInfo],
+    relationships: list[RelationshipInfo],
+    positions: dict[str, tuple[float, float]],
+    theme: Theme,
+    scale: int = 2,
+) -> bytes:
+    try:
+        import cairosvg
+    except ImportError:
+        raise ImportError(
+            "PNG export requires 'cairosvg'. Install it with: "
+            "pip install sqlalchemy-erd[png]"
+        )
+    svg_str = render_svg(tables, relationships, positions, theme, include_xml_header=True)
+    return cairosvg.svg2png(bytestring=svg_str.encode("utf-8"), scale=scale)
+
+
+def to_pdf(
+    tables: list[TableInfo],
+    relationships: list[RelationshipInfo],
+    positions: dict[str, tuple[float, float]],
+    theme: Theme,
+) -> bytes:
+    try:
+        import cairosvg
+    except ImportError:
+        raise ImportError(
+            "PDF export requires 'cairosvg'. Install it with: "
+            "pip install sqlalchemy-erd[pdf]"
+        )
+    svg_str = render_svg(tables, relationships, positions, theme, include_xml_header=True)
+    return cairosvg.svg2pdf(bytestring=svg_str.encode("utf-8"))