tedivm/paracelsus

🧪 Paracelsus: Công cụ sinh sơ đồ ERD từ SQLAlchemy bằng Mermaid hoặc Dot

Paracelsus đọc trực tiếp mô hình SQLAlchemy để tạo sơ đồ mối quan hệ cơ sở dữ liệu, hỗ trợ cả Mermaid và Dot.

Paracelsus là một công cụ dòng lệnh (CLI) giúp bạn tạo sơ đồ Entity Relationship Diagrams (ERD) từ các mô hình SQLAlchemy đã được định nghĩa. Dự án hỗ trợ xuất ra định dạng Mermaid hoặc Dot (Graphviz), đồng thời cho phép chèn sơ đồ trực tiếp vào tệp Markdown.

✨ Điểm nổi bật

• Hỗ trợ Mermaid: ERD có thể được chèn trực tiếp vào tài liệu dưới dạng sơ đồ Mermaid.
• Chạy trong CI/CD: Kiểm tra xem cơ sở dữ liệu có cập nhật không thông qua pipeline tự động.
• Xuất file Dot/Mermaid: Tạo tệp ERD ở định dạng Dot hoặc Mermaid.
• Tạo hình ảnh từ Dot: Dùng Dot để sinh SVG/PNG hoặc chỉnh sửa trong GraphViz.
• Tùy chọn bảng: Bao gồm hoặc loại trừ bảng bằng tên hoặc regex.
• Sắp xếp cột: Tùy chỉnh thứ tự cột (mặc định: PK, FK, sau đó tên cột).
• Xử lý dấu phẩy trong kiểu dữ liệu: Tự động thay thế dấu phẩy trong tham số kiểu để tránh lỗi Mermaid.
• Cấu hình linh hoạt: Hỗ trợ cấu hình qua pyproject.toml hoặc tệp cấu hình khác.

💡 Vì sao đáng chú ý

Paracelsus khác biệt vì khả năng tích hợp sâu vào quy trình làm việc tài liệu và CI/CD. Thay vì chỉ sinh sơ đồ tĩnh, công cụ cho phép tự động cập nhật sơ đồ khi mô hình thay đổi, đồng thời hỗ trợ cả Mermaid (dễ nhúng vào Markdown) và Dot (dễ tùy chỉnh bằng GraphViz). Điều này giúp giảm thiểu công việc thủ công trong việc duy trì tài liệu cơ sở dữ liệu.

---

#Python #SQLAlchemy #Mermaid #Graphviz #Documentation #TiniX