iplotx 0.8.0__py3-none-any.whl → 0.9.0__py3-none-any.whl

iplotx/__init__.py

@@ -9,19 +9,19 @@ library was used to construct the network.
 from .version import __version__
 from .plotting import (
     network,
+    graph,
     tree,
+    plot,
 )
 import iplotx.artists as artists
 import iplotx.style as style
 
 
-# Shortcut to iplotx.plotting.network
-plot = network
-
 __all__ = [
     "network",
     "tree",
     "plot",
+    "graph",
     "artists",
     "style",
     "__version__",

iplotx/plotting.py

@@ -22,6 +22,7 @@ def network(
     layout: Optional[LayoutType] = None,
     grouping: Optional[GroupingType] = None,
     vertex_labels: Optional[list | dict | pd.Series | bool] = None,
+    node_labels: Optional[list | dict | pd.Series | bool] = None,
     edge_labels: Optional[Sequence] = None,
     ax: Optional[mpl.axes.Axes] = None,
     style: str | dict | Sequence[str | dict] = (),
@@ -42,6 +43,9 @@ def network(
             will be drawn. If a list, the labels are taken from the list. If a dict, the keys
             should be the vertex IDs and the values should be the labels. If True (a single
             bool value), the vertex IDs will be used as labels.
+        node_labels: Same meaning as vertex_labels. This is an alias to help users who prefer
+            the word "node" over "vertex". If both vertex_labels and node_labels are specified,
+            "node_labels" overrides "vertex_labels".
         edge_labels: The labels for the edges. If None, no edge labels will be drawn. Defaults
             to None.
         ax: The axis to plot on. If None, a new figure and axis will be created. Defaults to
@@ -68,6 +72,11 @@ def network(
         The list can have one or two elements, depending on whether you are requesting to
         plot a network, a grouping, or both.
     """
+    # Equivalence of node_labels and vertex_labels
+    if node_labels is not None:
+        vertex_labels = node_labels
+    del node_labels
+
     stylecontext = context(style, **kwargs) if style or kwargs else nullcontext()
 
     with stylecontext:
@@ -126,11 +135,17 @@ def network(
         return artists
 
 
+# Aliases
+plot = network
+graph = network
+
+
 def tree(
     tree: Optional[TreeType] = None,
     layout: str | LayoutType = "horizontal",
     directed: bool | str = False,
     vertex_labels: Optional[list | dict | pd.Series | bool] = None,
+    node_labels: Optional[list | dict | pd.Series | bool] = None,
     leaf_labels: Optional[list | dict | pd.Series | bool] = None,
     show_support: bool = False,
     ax: Optional[mpl.axes.Axes] = None,
@@ -150,6 +165,9 @@ def tree(
         directed: If False, do not draw arrows.
         vertex_labels: The labels for the vertices. If None or False, no vertex labels. Also
             read leaf_labels for leaf nodes.
+        node_labels: Same meaning as vertex_labels. This is an alias to help users who prefer
+            the word "node" over "vertex". If both vertex_labels and node_labels are specified,
+            "node_labels" overrides "vertex_labels".
         leaf_labels: The labels for the leaf nodes. If None or False, no leaf labels are used
             except if vertex_labels are specified for leaf nodes. This argument and the
             previous vertex_labels provide somewhat redundant functionality but have quite
@@ -183,6 +201,11 @@ def tree(
     Returns:
         A TreeArtist object, set as a direct child of the matplotlib Axes.
     """
+    # Equivalence of node_labels and vertex_labels
+    if node_labels is not None:
+        vertex_labels = node_labels
+    del node_labels
+
     stylecontext = context(style, **kwargs) if style or kwargs else nullcontext()
 
     with stylecontext:

iplotx/version.py

@@ -2,4 +2,4 @@
 iplotx version information module.
 """
 
-__version__ = "0.8.0"
+__version__ = "0.9.0"

{iplotx-0.8.0.dist-info → iplotx-0.9.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: iplotx
-Version: 0.8.0
+Version: 0.9.0
 Summary: Plot networkx from igraph and networkx.
 Project-URL: Homepage, https://github.com/fabilab/iplotx
 Project-URL: Documentation, https://readthedocs.org/iplotx

{iplotx-0.8.0.dist-info → iplotx-0.9.0.dist-info}/RECORD

@@ -1,14 +1,14 @@
-iplotx/__init__.py,sha256=MKb9UCXKgDHHkeATuJWxYdM-AotfBo2fbWy-Rkbn9Is,509
+iplotx/__init__.py,sha256=RzSct91jO8abrxOIn33rKEnDUgYpu1oj4olbObgX_hs,489
 iplotx/artists.py,sha256=Bpn6NS8S_B_E4OW88JYW6aEu2bIuIQJmbs2paTmBAoY,522
 iplotx/cascades.py,sha256=OPqF7Huls-HFmDA5MCF6DEZlUeRVaXsbQcHBoKAgNJs,8182
 iplotx/groups.py,sha256=_9KdIiTAi1kXtd2mDywgBJCbqoRq2z-5fzOPf76Wgb8,6287
 iplotx/label.py,sha256=6am3a0ejcW_bWEXSOODE1Ke3AyCU1lJ45RfnXNbHAQw,8923
 iplotx/layout.py,sha256=KxmRLqjo8AYCBAmXez8rIiLU2sM34qhb6ox9AHYwRyE,4839
 iplotx/network.py,sha256=SGmXXrFxqgOoQcEJSZdL3WiI6rHDlPOGg5loGPrYpDk,11688
-iplotx/plotting.py,sha256=IEUxW1xzTljLjBfsVP2BNsOPCDpj5bEPZ99bzvD5-mo,10066
+iplotx/plotting.py,sha256=imlJZdx3S9B59TQPqrHEwQwJEnpI9SljthK34n3QJQY,11007
 iplotx/tree.py,sha256=TxbNoBHS0CfswrcMIWCNtnOl_3e4-PwCrVo0goywC0U,28807
 iplotx/typing.py,sha256=QLdzV358IiD1CFe88MVp0D77FSx5sSAVUmM_2WPPE8I,1463
-iplotx/version.py,sha256=tH4d2ah5uIPOD3rmxSuQMJ0PfIEEE0SOFEJKo0zwzXU,66
+iplotx/version.py,sha256=rlV8GqlJtRzwlHxPle9bW-H7xuYNreaGGD2bFrax930,66
 iplotx/vertex.py,sha256=hqdlD9fRBSwH5bRvlpaaPu7jgUR4z9nob1SYfPWDxtI,14966
 iplotx/edge/__init__.py,sha256=AVnLsrDWWCkix1LVhrjpWKEKDxOp8joM4tF6RqEHC8I,27115
 iplotx/edge/arrow.py,sha256=ZKt3UNZ7XRa2S3KxpoQfd4q_6eSUHOS476BZNqlf2pw,16462
@@ -33,6 +33,6 @@ iplotx/utils/geometry.py,sha256=6RrC6qaB0-1vIk1LhGA4CfsiMd-9JNniSPyL_l9mshE,9245
 iplotx/utils/internal.py,sha256=WWfcZDGK8Ut1y_tOHRGg9wSqY1bwSeLQO7dHM_8Tvwo,107
 iplotx/utils/matplotlib.py,sha256=wELE73quQv10-1w9uA5eDTgkZkylJvjg7pd3K5tZPOo,6294
 iplotx/utils/style.py,sha256=vyNP80nDYVinqm6_9ltCJCtjK35ZcGlHvOskNv3eQBc,4225
-iplotx-0.8.0.dist-info/METADATA,sha256=L756OyuMisG3j2Y_OsgvcqUcCavwDbVAPvfwBg7S9dQ,4908
-iplotx-0.8.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-iplotx-0.8.0.dist-info/RECORD,,
+iplotx-0.9.0.dist-info/METADATA,sha256=HQtb9YO4hhXGn0K8gaXBIAerAu1Eu0b4QiIHWCIZv2c,4908
+iplotx-0.9.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+iplotx-0.9.0.dist-info/RECORD,,