MkPipDepTree
Node to display a mermaid diagram for the dependencies.¶
Example: Regular¶
graph TD
classDef missing stroke-dasharray: 5
jinja2["Jinja2\n3.1.2"]
markupsafe["MarkupSafe\n2.1.3"]
jinja2 -- ">=2.0" --> markupsafe
Bases: MkDiagram
__init__ ¶
__init__(
package: types.ModuleType | str | None = None,
*,
direction: Literal["TD", "DT", "LR", "RL"] = "TD",
local_only: bool = False,
user_only: bool = False,
include_editables: bool = True,
editables_only: bool = False,
**kwargs: Any
)
Parameters:
Name | Type | Description | Default |
---|---|---|---|
package |
ModuleType | str | None
|
Package to show a dependency diagram for |
None
|
direction |
Literal['TD', 'DT', 'LR', 'RL']
|
diagram direction |
'TD'
|
local_only |
bool
|
Show ony local packages |
False
|
user_only |
bool
|
Show only user packages |
False
|
include_editables |
bool
|
Whether to include editable installs |
True
|
editables_only |
bool
|
Only return editable installs |
False
|
kwargs |
Any
|
Keyword arguments passed to parent |
{}
|
Name | Children | Inherits |
---|---|---|
MkDiagram mknodes.basenodes.mkdiagram Class representing a mermaid diagram. |
graph TD
94854583661264["mkpipdeptree.MkPipDepTree"]
94854574620240["mkdiagram.MkDiagram"]
94854582908560["mkcode.MkCode"]
94854582919984["mkcontainer.MkContainer"]
94854582916880["mknode.MkNode"]
94854582838576["node.Node"]
140544995341632["builtins.object"]
94854574620240 --> 94854583661264
94854582908560 --> 94854574620240
94854582919984 --> 94854582908560
94854582916880 --> 94854582919984
94854582838576 --> 94854582916880
140544995341632 --> 94854582838576
/home/runner/work/mknodes/mknodes/mknodes/templatenodes/mkpipdeptree/metadata.toml
[metadata]
name = "MkPipDepTree"
icon = "mdi:dependency"
status = "new"
group = "documentation"
[requirements.package.pipdeptree]
[examples.regular]
title = "Regular"
jinja = """
{{ "jinja2" | MkPipDepTree }}
"""
# [examples.direction]
# title = "Directed"
# jinja = """
# {{ mk.MkPipDepTree(direction="LR") }}
# """
[output.markdown]
template = """
{{ node.fence_boundary }} mermaid
{{ node.text }}
{{ node.fence_boundary }}
"""