interactive-figure 0.3.4__py3-none-any.whl → 0.3.5__py3-none-any.whl

interactive_figure/__about__.py

@@ -1 +1 @@
-__version__ = "0.3.4"
+__version__ = "0.3.5"

interactive_figure/interactive_figure.py

@@ -15,14 +15,14 @@ def create(aspect_ratio="auto", hide_toolbar=False, **kwargs):
     Parameters
     ----------
     aspect_ratio : str, optional
-        aspect ratio of the Axes, by default "auto"
+        aspect ratio of the Axes, default "auto".
     hide_toolbar : bool, optional
-        whether to hide the toolbar, by default False
+        whether to hide the toolbar, default False.
 
-    remaining arguments will be sent to the figure upon creation
+    Remaining arguments will be sent to the figure upon creation.
 
     Raises
-    ------
+    ----------
     RuntimeError
         if multiple interactive figures are created.
     """
@@ -62,6 +62,7 @@ def create(aspect_ratio="auto", hide_toolbar=False, **kwargs):
     else:
         raise RuntimeError("Error: you cannot create multiple interactive figures.")
 
+
 def draw():
     """Draw contents of the figure."""
     _check_exists()
@@ -75,10 +76,15 @@ def draw():
 
 
 def clear(hide_labels=False, set_limits=True):
-    """Reset contents and layout of the figure. 
-    
-    *set_limits* will set the Axes limits to 
-    [0, 100]. *hide_labels* will remove all labels."""
+    """Reset contents and layout of the figure.
+
+    Parameters
+    ----------
+    set_limits : bool, optional
+        set the Axes limits to [0, 100].
+    hide_labels : bool, optional
+        remove all labels from the figure.
+    """
     _check_exists()
 
     ax = _state.ax
@@ -172,7 +178,7 @@ def get_last_key_press():
     Returns
     -------
     str | None
-        The last key that was pressed
+        The last key that was pressed.
     """
     _check_exists()
 
@@ -190,7 +196,7 @@ def get_last_mouse_press():
     Returns
     -------
     int | None
-        The identifier of the last mouse button that was pressed
+        The identifier of the last mouse button that was pressed.
     """
     _check_exists()
 
@@ -208,7 +214,7 @@ def get_last_mouse_pos():
     Returns
     -------
     (x: float, y: float) | (None, None)
-        The last registered mouse position after any interaction
+        The last registered mouse position after any interaction.
     """
     _check_exists()
 
@@ -224,7 +230,7 @@ def wait(timeout):
     Parameters
     ----------
     timeout : float
-        Number of seconds to wait for
+        Number of seconds to wait for.
     """
     _check_exists()
 
@@ -233,7 +239,7 @@ def wait(timeout):
     _state_reset_press()
 
 
-# PRIVATE METHODS
+# HIDDEN METHODS
 
 
 def _get_state():

{interactive_figure-0.3.4.dist-info → interactive_figure-0.3.5.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: interactive-figure
-Version: 0.3.4
+Version: 0.3.5
 Summary: Create interactive Matplotlib figures!
 Project-URL: Documentation, https://teuncm.github.io/interactive-figure/autoapi/interactive_figure/interactive_figure/index.html
 Project-URL: Issues, https://github.com/teuncm/interactive-figure/issues
@@ -63,6 +63,9 @@ hatch shell
 hatch version fix
 hatch build -c
 ./generate_docs.sh
+
+# Publish
+hatch publish
 ```
 
 ## Links

interactive_figure-0.3.5.dist-info/RECORD

@@ -0,0 +1,7 @@
+interactive_figure/__about__.py,sha256=hu_23GWCWpKjdw97-0y_O7JlxUWN4apUKOL4q5xXd7Q,23
+interactive_figure/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+interactive_figure/interactive_figure.py,sha256=hvQX5OACBYoz5EK9Wd3aOZm6I79ia6PGg69CtkPl_Mo,8410
+interactive_figure-0.3.5.dist-info/METADATA,sha256=WYQ6OrtTdjiUS3npBEhymGvE5Fc2Pc7PxLBPGCYr-4U,2438
+interactive_figure-0.3.5.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
+interactive_figure-0.3.5.dist-info/licenses/LICENSE.txt,sha256=R6IpPdPKA5nLHPKRXIhlFHLE59dMUtve0qeXhZPr0Hk,1043
+interactive_figure-0.3.5.dist-info/RECORD,,

interactive_figure-0.3.4.dist-info/RECORD

@@ -1,7 +0,0 @@
-interactive_figure/__about__.py,sha256=EVh84K2XkED4bsPB10qR4q6SCbIp-6LdYq5IuJweVoo,23
-interactive_figure/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-interactive_figure/interactive_figure.py,sha256=l3AWVe6oQePBCcv3kGb5qEV_qxHWiuZeXyrxd5OlZTk,8318
-interactive_figure-0.3.4.dist-info/METADATA,sha256=Yx_G-2KYRrZ0IcVf1ZO1zewjlEZG66a02eVbOJJAQvQ,2413
-interactive_figure-0.3.4.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
-interactive_figure-0.3.4.dist-info/licenses/LICENSE.txt,sha256=R6IpPdPKA5nLHPKRXIhlFHLE59dMUtve0qeXhZPr0Hk,1043
-interactive_figure-0.3.4.dist-info/RECORD,,