docs for v0.0.0

endremborza · Apr 27, 2022 · 460f5db · 460f5db
1 parent 81fbe01
commit 460f5db
Show file tree

Hide file tree

Showing 8 changed files with 103 additions and 0 deletions.
diff --git a/docs/api/sqlmermaid.format_col_type.rst b/docs/api/sqlmermaid.format_col_type.rst
@@ -0,0 +1,6 @@
+format_col_type
+===============
+
+.. currentmodule:: sqlmermaid
+
+.. autofunction:: format_col_type
diff --git a/docs/api/sqlmermaid.get_mermaid.rst b/docs/api/sqlmermaid.get_mermaid.rst
@@ -0,0 +1,6 @@
+get_mermaid
+===========
+
+.. currentmodule:: sqlmermaid
+
+.. autofunction:: get_mermaid
diff --git a/docs/api/sqlmermaid.open_in_browser.rst b/docs/api/sqlmermaid.open_in_browser.rst
@@ -0,0 +1,6 @@
+open_in_browser
+===============
+
+.. currentmodule:: sqlmermaid
+
+.. autofunction:: open_in_browser
diff --git a/docs/api/sqlmermaid.to_file.rst b/docs/api/sqlmermaid.to_file.rst
@@ -0,0 +1,6 @@
+to_file
+=======
+
+.. currentmodule:: sqlmermaid
+
+.. autofunction:: to_file
diff --git a/docs/api/sqlmermaid.to_mermaid_node.rst b/docs/api/sqlmermaid.to_mermaid_node.rst
@@ -0,0 +1,6 @@
+to_mermaid_node
+===============
+
+.. currentmodule:: sqlmermaid
+
+.. autofunction:: to_mermaid_node
diff --git a/docs/notebooks/doc-000-intro.rst b/docs/notebooks/doc-000-intro.rst
@@ -0,0 +1,11 @@
+Installation:
+=============
+
+using pip
+---------
+
+``pip install sqlmermaid``
+
+.. code:: ipython3
+
+    from sqlmermaid import __version__
diff --git a/docs/notebooks/doc-001-quickstart.rst b/docs/notebooks/doc-001-quickstart.rst
@@ -0,0 +1,58 @@
+.. code:: ipython3
+
+    import sqlalchemy as sa
+    
+    from sqlmermaid import get_mermaid
+    
+    
+    metadata_obj = sa.MetaData()
+
+.. code:: ipython3
+
+    user = sa.Table(
+        "user",
+        metadata_obj,
+        sa.Column("user_id", sa.Integer, primary_key=True),
+        sa.Column("user_name", sa.String(16), nullable=False),
+        sa.Column("email_address", sa.String(60)),
+        sa.Column("nickname", sa.String(50), nullable=False),
+    )
+
+.. code:: ipython3
+
+    departments = sa.Table(
+        "departments",
+        metadata_obj,
+        sa.Column("department_id", sa.Integer, primary_key=True),
+        sa.Column("department_name", sa.String(60), nullable=False),
+    )
+
+.. code:: ipython3
+
+    employees = sa.Table(
+        "employees",
+        metadata_obj,
+        sa.Column("employee_id", sa.Integer, primary_key=True),
+        sa.Column("employee_name", sa.String(60), nullable=False),
+        sa.Column("employee_dept", sa.Integer, sa.ForeignKey("departments.department_id")),
+    )
+
+.. code:: ipython3
+
+    user_complaints = sa.Table(
+        "complaints",
+        metadata_obj,
+        sa.Column("about_dept", sa.Integer, sa.ForeignKey("departments.department_id")),
+        sa.Column("by_user", sa.Integer, sa.ForeignKey("user.user_id")),
+        sa.Column("at_time", sa.DateTime),
+        sa.Column("text", sa.String(500)),
+        sa.Index("comp_ind", "text"),
+    )
+
+.. code:: ipython3
+
+    constr = "sqlite:///db3.sqlite"  # "sqlite:///:memory:"
+    engine = sa.create_engine(constr)
+    metadata_obj.create_all(engine)
+    
+    print(get_mermaid(constr))
diff --git a/docs/release_notes/v0.0.0.rst b/docs/release_notes/v0.0.0.rst
@@ -0,0 +1,4 @@
+v0.0.0
+------
+
+yay, first release