Merge branch 'master' of github.com:i2mint/titbit

setup.cfg

@@ -2,7 +2,7 @@
 root_url = https://github.com/i2mint/
 license = apache-2.0
 author = OtoSense
-version = 0.0.1
+version = 0.1.0
 description = A place to dump might-be-useful-again code as an alternative of leaving in a notebook where it will never be found again
 description_file = README.md
 long_description = file:README.md
@@ -17,5 +17,6 @@ packages = find:
 include_package_data = True
 zip_safe = False
 install_requires = 
+	lkj
 
 

titbit/__init__.py

@@ -68,9 +68,25 @@ def _git_action(project):
 
 
 def mermaid_to_graphviz(
-    mermaid_code, extra_replacements=(), *, prefix="", suffix="", egress=None
+    mermaid_code, extra_replacements=(), *, prefix='', suffix='', egress=None
 ):
-    """Converts mermaid code to graphviz code."""
+    """Converts mermaid code to graphviz code.
+    
+    >>> mermaid_code = '''
+    ... graph TD
+    ... A --> B & C
+    ... B & C --> D
+    ... '''
+    >>> graphviz_code = mermaid_to_graphviz(mermaid_code)
+    >>> print(graphviz_code)  # doctest: +NORMALIZE_WHITESPACE
+    digraph G {
+    <BLANKLINE>
+    graph TD
+        A -> B , C
+        B , C -> D
+    <BLANKLINE>
+    }
+    """
 
     from lkj import regex_based_substitution, import_object
 
@@ -79,20 +95,20 @@ def mermaid_to_graphviz(
     elif isinstance(egress, str):
         egress = import_object(egress)
     else:
-        assert callable(egress), f"egress must be a callable or a string, not {egress}"
+        assert callable(egress), f'egress must be a callable or a string, not {egress}'
 
     mermaid_to_graphviz_replacements = (
-        ("-->", "->"),
-        ("&", ","),
+        ('-->', '->'),
+        ('&', ','),
     )
     mermaid_to_graphviz_replacements = mermaid_to_graphviz_replacements + tuple(
         extra_replacements
     )
     s = mermaid_code
     # remove the first line if it starts with 'graph'
-    s = "\n".join(s.split("\n")[1:]) if s.startswith("graph") else s
+    s = '\n'.join(s.split('\n')[1:]) if s.startswith('graph') else s
     # carry out the replacements
     s = regex_based_substitution(mermaid_to_graphviz_replacements)(s)
     # add the prefix and suffix and wrap it in the graphviz graph declaration
-    s = "digraph G {" + "\n" + f"{prefix}" + s + "\n" + suffix
-    return s + "}"
+    s = 'digraph G {' + '\n' + f'{prefix}' + s + '\n' + suffix
+    return s + '}'