Metadata-Version: 2.1
Name: sqlmermaid
Version: 0.1.0
Summary: Visualizing SQL databases
Author-email: Endre Márk Borza <endremborza@gmail.com>
Requires-Python: >=3.8
Description-Content-Type: text/markdown
Requires-Dist: sqlalchemy
Requires-Dist: branthebuilder[doc] ; extra == "doc"
Requires-Dist: sphinxcontrib-mermaid ; extra == "doc"
Requires-Dist: branthebuilder ; extra == "test"
Project-URL: Homepage, https://github.com/endremborza/sqlmermaid
Provides-Extra: doc
Provides-Extra: test

# sqlmermaid

[![Documentation Status](https://readthedocs.org/projects/sqlmermaid/badge/?version=latest)](https://sqlmermaid.readthedocs.io/en/latest)
[![codeclimate](https://img.shields.io/codeclimate/maintainability/endremborza/sqlmermaid.svg)](https://codeclimate.com/github/endremborza/sqlmermaid)
[![codecov](https://img.shields.io/codecov/c/github/endremborza/sqlmermaid)](https://codecov.io/gh/endremborza/sqlmermaid)
[![pypi](https://img.shields.io/pypi/v/sqlmermaid.svg)](https://pypi.org/project/sqlmermaid/)

Creates pretty schema diagrams like this one, simply from a constring

```{mermaid}
   erDiagram
     complaints {    
       INTEGER about_dept FK     
       INTEGER by_user FK     
       DATETIME at_time      
       VARCHAR-500 text  "in index: comp_ind"
     }
     departments {    
       INTEGER department_id PK     
       VARCHAR-60 department_name  
     }
     user {    
       INTEGER user_id PK     
       VARCHAR-16 user_name      
       VARCHAR-60 email_address      
       VARCHAR-50 nickname  
     }
     employees {    
       INTEGER employee_id PK     
       VARCHAR-60 employee_name      
       INTEGER employee_dept FK 
     }
     complaints ||--|{ user : "by_user"
     complaints ||--|{ departments : "about_dept"
     employees ||--|{ departments : "employee_dept"
```

```mermaid
   erDiagram
     complaints {    
       INTEGER about_dept FK     
       INTEGER by_user FK     
       DATETIME at_time      
       VARCHAR-500 text  "in index: comp_ind"
     }
     departments {    
       INTEGER department_id PK     
       VARCHAR-60 department_name  
     }
     user {    
       INTEGER user_id PK     
       VARCHAR-16 user_name      
       VARCHAR-60 email_address      
       VARCHAR-50 nickname  
     }
     employees {    
       INTEGER employee_id PK     
       VARCHAR-60 employee_name      
       INTEGER employee_dept FK 
     }
     complaints ||--|{ user : "by_user"
     complaints ||--|{ departments : "about_dept"
     employees ||--|{ departments : "employee_dept"
```

