kitikiplot 0.1.4__py3-none-any.whl → 0.1.6__py3-none-any.whl

kitikiplot/kitiki_cell.py

@@ -1,11 +1,12 @@
 """
 File Name: kitiki_cell.py
-Description: This file defines the 'KitikiCell' class for each rectangular cell in kitiki plot
+Description: This file defines the 'KitikiCell' class for each rectangular cell in KitikiPlot
 Author: Boddu Sri Pavan
 Date Created: 21-10-2024
-Last Modified: 07-12-2024
+Last Modified: 19-02-2025
 """
 
+# Import necessary libraries
 from typing import List, Dict, Union
 import pandas as pd
 import matplotlib.patches as mpatches
@@ -156,6 +157,11 @@ class KitikiCell(ColorConfig):
             # Calculate dimensions for the rectangle based on grid position and size parameters for transposed layout
             rect_dim= (cell_height*(y+1)+ align_factor, window_gap*(self.rows- x+1)+ cell_width*(self.rows- x+1))
 
+
+        # Clean up all local variables for efficient memory management
+        # del align_factor, rect_dim, x, y, cell_width, cell_height, align, window_gap
+        locals().clear() 
+
         # Return a Rectangle object with specified dimensions and styles based on input parameters
         return Rectangle( rect_dim,
            width= cell_width, 

kitikiplot/kitiki_color_config.py

@@ -1,10 +1,12 @@
 """
 File Name: kitiki_color_config.py
-Description: This file defines the 'ColorConfig' class for managing input data(list, dataframe) and configuring color, hatch of kitiki plot
+Description: This file defines the 'ColorConfig' class for managing input data(list, dataframe) and configuring color, hatch of KitikiPlot
 Author: Boddu Sri Pavan
 Date Created: 21-10-2024
-Last Modified: 23-11-2024
+Last Modified: 19-02-2025
 """
+
+# Import necessary libraries
 from typing import Tuple, Union, Dict
 import random
 import math
@@ -12,6 +14,7 @@ import numpy as np
 import pandas as pd
 import matplotlib
 import matplotlib.pyplot as plt
+import gc
 
 class ColorConfig:
     """
@@ -134,7 +137,14 @@ class ColorConfig:
             # Append the row to the list
             l.append( row_data )
         
-        # Convert the list of rows into a 'pd.DataFrame' and return it
+        # Clean up all local variables for efficient memory management
+        # del n_rows, data, window_length, stride, i, row_data
+        locals().clear()
+        
+        # Trigger garbage collection for efficient memory management
+        gc.collect()
+
+        # Convert the list of rows into a 'pda.DataFrame' and return it
         return pd.DataFrame( l )
 
     def unique_config(self) -> Tuple[np.ndarray, int]:
@@ -156,6 +166,9 @@ class ColorConfig:
         # Calculate the number of unique values found in the DataFrame
         n_unique= unique_values.shape[0]
 
+        # Trigger garbage collection for efficient memory management
+        gc.collect()
+
         # Return both the array of unique values and their count
         return unique_values, n_unique
 
@@ -211,6 +224,13 @@ class ColorConfig:
                         # Assign fallback color for any missing unique value
                         color_map.update( {each_unique: fallback_color} )
 
+        # Clean up all local variables for efficient memory management
+        # del unique_values, n_unique, cmap, custom_palette, i
+        locals().clear()
+
+        # Trigger garbage collection for efficient memory management
+        gc.collect()
+
         # Return the final color mapping and the specified edge color
         return color_map, edge_color
     
@@ -262,5 +282,12 @@ class ColorConfig:
         elif display_hatch== True and len(h_map)==0:
             h_map= dict(zip(unique_values, HATCH_PATTERN[:n_unique]))
 
+        # Clean up all local variables for efficient memory management
+        # del HATCH_PATTERN, unique_values, n_unique, display_hatch, each_unique_value, fallback_hatch
+        locals().clear()
+
+        # Trigger garbage collection for efficient memory management
+        gc.collect()
+
         # Return the configured 'h_map'
         return h_map

kitikiplot/kitikiplot.py

@@ -1,17 +1,19 @@
 """
-File Name: Kiti.py
-Description: This file defines the 'KitikiPlot' class for generating kitki plot for categorical sequential& time-series data
+File Name: kitikiplot.py
+Description: This file defines the 'KitikiPlot' class to visualize categorical sliding window data
 Author: Boddu Sri Pavan
 Date Created: 21-10-2024
-Last Modified: 23-11-2024
+Last Modified: 19-02-2025
 """
 
+# Import necessary libraries
 from typing import List, Union
 import pandas as pd
 import matplotlib
 import matplotlib.pyplot as plt
 import matplotlib.patches as mpatches
 from .kitiki_cell import KitikiCell
+import gc
 
 class KitikiPlot(KitikiCell):
     """
@@ -90,6 +92,7 @@ class KitikiPlot(KitikiCell):
               display_grid: bool = False,
               display_legend: bool = False,
               legend_hatch: bool = False,
+              return_figure: bool = False,
               legend_kwargs: dict = {},
               kitiki_cell_kwargs: dict = {}
             ) -> None:
@@ -398,6 +401,16 @@ class KitikiPlot(KitikiCell):
             # Pass in the color map, hatch map, and any additional keyword arguments for customization
             self.legend( ax= ax, color_map= self.color_map,hatch_map= self.hatch_map, legend_hatch= legend_hatch, **legend_kwargs  )
 
+        # Clean up all local variables for efficient memory management
+        locals().clear()
+
+        # Trigger garbage collection for efficient memory management
+        gc.collect()
+
+        # Return the figure object if 'return_figure' is set to True
+        if return_figure:
+            return fig
+
         # Show the plot with all configurations applied
         plt.show()
 
@@ -439,7 +452,11 @@ class KitikiPlot(KitikiCell):
             # The hatch pattern is specified based on the 'hatch_map', multiplied by 2 for visibility
             legend_patches= [mpatches.Patch(facecolor= color_map[0][key], label= key, hatch= r"{}".format(hatch_map[key]*2)) for key in color_map[0]]
             
-        kwargs= legend_kwargs
+        # Clean up all local variables for efficient memory management
+        locals().clear()
+
+        # Trigger garbage collection for efficient memory management
+        gc.collect()
 
         # Return the created legend object, attaching the generated patches and any additional kwargs
         return ax.legend(handles=legend_patches, **legend_kwargs)

{kitikiplot-0.1.4.dist-info → kitikiplot-0.1.6.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: kitikiplot
-Version: 0.1.4
+Version: 0.1.6
 Summary: A Python library to visualize categorical sliding window data.
 Home-page: https://github.com/BodduSriPavan-111/kitikiplot
 Author: Boddu Sri Pavan
@@ -75,11 +75,21 @@ ktk.plot( display_legend= True ) # Display the legend
 ```
 Check out the complete <b>guide of customization</b> [here](https://github.com/BodduSriPavan-111/kitikiplot/blob/main/examples/Usage_Guide.ipynb).
 
+## To-do
+- [ ] Streamlit Demo Interface (In Progress: app.py)
+- [ ] Tooltip
+- [ ] Interactive Plot
+- [ ] Multithreading to decrease plotting latency
+- [ ] CI/CD Pipeline
+- [ ] Domain-specific modules
+- [ ] Website for documentation
+
 Please refer <a href="https://github.com/BodduSriPavan-111/kitikiplot/blob/main/CONTRIBUTING.md">CONTRIBUTING.md</a> for <b>contributions</b> to kitikiplot.
 
-### Author
-<a href="https://www.linkedin.com/in/boddusripavan/"> Boddu Sri Pavan </a> & 
-<a href="https://www.linkedin.com/in/boddu-swathi-sree-2a2a58332/"> Boddu Swathi Sree </a>
+To join the Discord server for more discussion, click <a href="https://discord.gg/PQKtqm5p">here</a>
+
+### Key Author
+<a href="https://www.linkedin.com/in/boddusripavan/"> Boddu Sri Pavan </a>
 
 ## Citation
 APA <br>
@@ -103,4 +113,8 @@ BibTeX <br>
 >  url          = {https://doi.org/10.5281/zenodo.14632005},       <br>
 >}
 
+## Executing Tests when contributing to kitikiplot
+
+Please refer <a href="https://github.com/BodduSriPavan-111/kitikiplot/blob/main/tests/unit_test/Readme.md">Readme.md</a> to run the tests
+
 ## Thank You !

kitikiplot-0.1.6.dist-info/RECORD

@@ -0,0 +1,9 @@
+kitikiplot/__init__.py,sha256=7LpJy1V-PZ-JlfjsnRMjMXxTKaFt0JP0mj-A0SgS-sE,34
+kitikiplot/kitiki_cell.py,sha256=9kn33x8-4Zp_fVdmp5NK-V7fm3hDXZOxwCNO3uDZqIo,7016
+kitikiplot/kitiki_color_config.py,sha256=No_ayqgQUYXRE7g62obFKVn6avn4jdGn3WuSqZ6F3tA,11677
+kitikiplot/kitikiplot.py,sha256=uH5eQnWxswQsDC1b77cu5U_2m3ODfKRGqCxcredRagQ,19746
+kitikiplot-0.1.6.dist-info/LICENSE,sha256=14Bs-3ieyNjj9kCnVLv8CHRXEvQVM6P5uLe-pz7cBI0,1088
+kitikiplot-0.1.6.dist-info/METADATA,sha256=l1vENGblnJamx4ai1SgqcnpEWurapoj_p3YFMlrMxJ0,5164
+kitikiplot-0.1.6.dist-info/WHEEL,sha256=tZoeGjtWxWRfdplE7E3d45VPlLNQnvbKiYnx7gwAy8A,92
+kitikiplot-0.1.6.dist-info/top_level.txt,sha256=nqjD8Sil5L7rfBQtnmLdJMR-u2BdVFnusZlOIU0Yd00,11
+kitikiplot-0.1.6.dist-info/RECORD,,

{kitikiplot-0.1.4.dist-info → kitikiplot-0.1.6.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (72.1.0)
+Generator: bdist_wheel (0.45.1)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

kitikiplot-0.1.4.dist-info/RECORD

@@ -1,9 +0,0 @@
-kitikiplot/__init__.py,sha256=7LpJy1V-PZ-JlfjsnRMjMXxTKaFt0JP0mj-A0SgS-sE,34
-kitikiplot/kitiki_cell.py,sha256=N356LoJACH7qjoVn0T0GpLPVmXnyr6bBmM19dhLY7J8,6796
-kitikiplot/kitiki_color_config.py,sha256=_HsOr1txgj8E4-Xro6-ekLSRH0FSrSnzvpXjAD2AbMw,10718
-kitikiplot/kitikiplot.py,sha256=eOxtrRjg2u7AeDw4l1qE6qwutTlmKur_xpqLAnJViSs,19203
-kitikiplot-0.1.4.dist-info/LICENSE,sha256=14Bs-3ieyNjj9kCnVLv8CHRXEvQVM6P5uLe-pz7cBI0,1088
-kitikiplot-0.1.4.dist-info/METADATA,sha256=HqGg3Gm714J-7zLjatXrKP13IvVv0irm-Xwe5qMdvAk,4714
-kitikiplot-0.1.4.dist-info/WHEEL,sha256=R0nc6qTxuoLk7ShA2_Y-UWkN8ZdfDBG2B6Eqpz2WXbs,91
-kitikiplot-0.1.4.dist-info/top_level.txt,sha256=nqjD8Sil5L7rfBQtnmLdJMR-u2BdVFnusZlOIU0Yd00,11
-kitikiplot-0.1.4.dist-info/RECORD,,