/PythonToMermaid

An application to generate Mermaid class diagrams using the source code of a Python project.

Primary LanguagePythonMIT LicenseMIT

PythonToMarkdown

Generates a mermaid class diagram in markdown from python source code. This project is based on RafaelKuebler's PyToUML, which generates a plantUML diagram based on the source data.

This project generates a text file containing Mermaid markdown class diagrams based on the source code of a Python project.

Using PythonToMarkdown

You will need to have Java installed in order to use PythonToMarkdown. Run the tool through the command line as follows:

python run.py <SOURCE_PATH>

classDiagram

class Foobar{
    +String var foo
    bar()
}

class Foobar2{
    +String var foo
    bar()

}
class Foobar3{
    +String var foo
    bar()

}
class Foobar4{
    +String var foo
    bar()
}

Foobar <|-- Foobar2
Foobar <|-- Foobar3
Foobar <|-- Foobar4
Loading

License

This project is licensed under the MIT License - see the LICENSE.md file for details