collective / pipforester

Forester tools for pipdeptree
Other
1 stars 1 forks source link

Create mermaid diagrams #4

Open gforcada opened 1 year ago

gforcada commented 1 year ago

Unfortunately GitHub does not support the DOT format, but instead the mermaid one

A simple example:

graph TD;
    plone.app.layout[plone.app.layout\n2.3.x]
    plone.app.dexterity[plone.app.dexterity\n3.x]
    plone.base[plone.base\n1.x]
    Zope[Zope and friends]

    plone.app.layout-->plone.base;
    plone.app.layout-->plone.app.dexterity;
    plone.app.dexterity-->plone.base;
    plone.base-->Zope;

Source:

graph TD;
    plone.app.layout[plone.app.layout\n2.3.x]
    plone.app.dexterity[plone.app.dexterity\n3.x]
    plone.base[plone.base\n1.x]
    Zope[Zope and friends]

    plone.app.layout-->plone.base;
    plone.app.layout-->plone.app.dexterity;
    plone.app.dexterity-->plone.base;
    plone.base-->Zope;

Notice that one has to specify identifiers and labels id[visual label] and on the edges can only use identifiers id1-->id2.

The idea would be to get pipforester run on all Plone repositories and output the circular dependencies in the GHA job summary. 🚀

gforcada commented 2 weeks ago

As the network backend is networkx, it would be much better if it's added there.

Seems they are not against it actually: https://github.com/networkx/networkx/discussions/6693