kitikiplot 0.1.5__py3-none-any.whl → 0.1.7__py3-none-any.whl

{kitikiplot-0.1.5.dist-info → kitikiplot-0.1.7.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: kitikiplot
-Version: 0.1.5
+Version: 0.1.7
 Summary: A Python library to visualize categorical sliding window data.
 Home-page: https://github.com/BodduSriPavan-111/kitikiplot
 Author: Boddu Sri Pavan
@@ -76,15 +76,18 @@ 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 Interfaces
+- [ ] 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.
 
+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>
 
@@ -110,4 +113,8 @@ BibTeX <br>
 >  url          = {https://doi.org/10.5281/zenodo.14632005},       <br>
 >}
 
-## Thank You !
+## 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.7.dist-info/RECORD

@@ -0,0 +1,12 @@
+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
+tests/__init__.py,sha256=G6t2Zarmz7Akl21Pmws08EK9CXqJv6In4sCr2LLRqqk,34
+tests/unit_test/__init__.py,sha256=G6t2Zarmz7Akl21Pmws08EK9CXqJv6In4sCr2LLRqqk,34
+tests/unit_test/unit_test.py,sha256=MA4yspvTtnE5kP7j-TYB9ECtbvJQKrDskzRU3JKzNww,4323
+kitikiplot-0.1.7.dist-info/LICENSE,sha256=14Bs-3ieyNjj9kCnVLv8CHRXEvQVM6P5uLe-pz7cBI0,1088
+kitikiplot-0.1.7.dist-info/METADATA,sha256=ttgqnMjJaFIjzyFORJKqCd6q77mT25tUGdVP83MdJ-w,5166
+kitikiplot-0.1.7.dist-info/WHEEL,sha256=tZoeGjtWxWRfdplE7E3d45VPlLNQnvbKiYnx7gwAy8A,92
+kitikiplot-0.1.7.dist-info/top_level.txt,sha256=SjfefiiV1oUpgCKjYpjF2JmFGORHqePe1zAm1JcwBNg,17
+kitikiplot-0.1.7.dist-info/RECORD,,

{kitikiplot-0.1.5.dist-info → kitikiplot-0.1.7.dist-info}/WHEEL

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

{kitikiplot-0.1.5.dist-info → kitikiplot-0.1.7.dist-info}/top_level.txt

@@ -1 +1,2 @@
 kitikiplot
+tests

tests/__init__.py

@@ -0,0 +1,2 @@
+import sys
+sys.path.append('.')

tests/unit_test/__init__.py

@@ -0,0 +1,2 @@
+import sys
+sys.path.append('.')

tests/unit_test/unit_test.py

@@ -0,0 +1,129 @@
+"""
+------------------------------------------------------------------------------
+File: unit_test.py
+Description: This file contains test cases for the KitikiPlot class, ensuring 
+             its functionality across different data types and edge cases.
+Created On: March 22, 2025
+------------------------------------------------------------------------------
+"""
+
+""" Import necessary libraries """
+import pytest
+import sys
+import pandas as pd
+import matplotlib.patches as mpatches
+import numpy as np
+from numpy.testing import assert_array_equal
+
+sys.path.insert(0, '../kitikiplot')
+from kitikiplot import KitikiPlot
+
+""" Fixtures for providing sample data """
+
+@pytest.fixture
+def sample_data():
+    """ 
+    Returns a sample Pandas DataFrame for testing.
+    """
+    return pd.DataFrame({"A": [1, 2, 3], "B": [4, 5, 6]})
+
+@pytest.fixture
+def sample_list():
+    """ 
+    Returns a sample list for testing list-based initialization.
+    """
+    return [1, 2, 3, 4, 5, 6, 7, 8, 9, 10]
+
+@pytest.fixture
+def kitiki_plot(sample_data):
+    """ 
+    Creates an instance of KitikiPlot using sample data.
+    """
+    return KitikiPlot(data=sample_data)
+
+@pytest.fixture
+def cmap():
+    """ 
+    Returns a colormap dictionary for testing color mapping.
+    """
+    return {0: {1: "red", 2: "blue", 3: "green"}, 1: "black"}
+
+@pytest.fixture
+def hmap():
+    """ 
+    Returns a hatch map dictionary for testing hatch patterns.
+    """
+    return {1: "//", 2: "\\", 3: "||"}
+
+""" Testing Initialization with Different Data Types """
+
+def test_kitiki_plot_initialization(sample_data):
+    """ 
+    Tests if KitikiPlot initializes properly with a DataFrame. 
+    """
+    plot = KitikiPlot(data=sample_data)
+    assert isinstance(plot, KitikiPlot)
+
+def test_kitiki_plot_with_empty_dataframe():
+    """ 
+    Tests if KitikiPlot initializes properly with an empty DataFrame. 
+    """
+    empty_df = pd.DataFrame()
+    plot = KitikiPlot(data=empty_df)
+    assert isinstance(plot, KitikiPlot)
+
+def test_kitiki_plot_with_list(sample_list):
+    """ 
+    Tests if KitikiPlot initializes properly with a list.
+    """
+    plot = KitikiPlot(data=sample_list, stride=2, window_length=5)
+    assert isinstance(plot, KitikiPlot)
+
+def test_kitiki_plot_with_nested_list():
+    """ 
+    Tests if KitikiPlot initializes properly with a nested list. 
+    """
+    nested_list = [[1, 2], [3, 4], [5, 6]]
+    plot = KitikiPlot(data=nested_list, stride=1, window_length=2)
+    assert isinstance(plot, KitikiPlot)
+
+""" Testing Edge Cases for 'create' Method """
+
+def test_create_rectangle(kitiki_plot, cmap, hmap):
+    """ 
+    Tests if the 'create' method generates a valid rectangle object.
+    """
+    rect = kitiki_plot.create(
+        x=0, y=0, each_sample=[1, 2, 3], cell_width=0.5, cell_height=2.0, 
+        window_gap=1.0, align=True, cmap=cmap, edge_color='black', 
+        fallback_color='white', hmap=hmap, fallback_hatch=' ', 
+        display_hatch=True, transpose=False
+    )
+    assert isinstance(rect, mpatches.Rectangle)
+
+def test_create_invalid_rectangle(kitiki_plot, cmap, hmap):
+    """ 
+    Tests if the 'create' method raises a KeyError for missing cmap/hmap values. 
+    """
+    with pytest.raises(KeyError) as exc_info:
+        kitiki_plot.create(
+            x=0, y=0, each_sample=[10], cell_width=0.5, cell_height=2.0, 
+            window_gap=1.0, align=True, cmap=cmap, edge_color='black', 
+            fallback_color='white', hmap=hmap, fallback_hatch=' ', 
+            display_hatch=True, transpose=False
+        )
+    print(f"exc value is equal to {exc_info.value} and type is {type(exc_info.value)}")
+    assert str(10) in str(exc_info.value)
+
+def test_create_rectangle_with_unknown_values(kitiki_plot, cmap, hmap):
+    """ 
+    Tests if the 'create' method raises a KeyError for unknown cmap/hmap values.
+    """
+    with pytest.raises(KeyError) as exc_info:
+        kitiki_plot.create(
+            x=0, y=0, each_sample=[99], cell_width=0.5, cell_height=2.0,
+            window_gap=1.0, align=True, cmap=cmap, edge_color='black',
+            fallback_color='white', hmap=hmap, fallback_hatch=' ',
+            display_hatch=True, transpose=False
+        )
+    assert str(99) in str(exc_info.value)

kitikiplot-0.1.5.dist-info/RECORD

@@ -1,9 +0,0 @@
-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.5.dist-info/LICENSE,sha256=14Bs-3ieyNjj9kCnVLv8CHRXEvQVM6P5uLe-pz7cBI0,1088
-kitikiplot-0.1.5.dist-info/METADATA,sha256=VYUoJF9Ob5Mqoa8RY3rf0r0jRgyLXLzTQON4axkEQig,4811
-kitikiplot-0.1.5.dist-info/WHEEL,sha256=eOLhNAGa2EW3wWl_TU484h7q1UNgy0JXjjoqKoxAAQc,92
-kitikiplot-0.1.5.dist-info/top_level.txt,sha256=nqjD8Sil5L7rfBQtnmLdJMR-u2BdVFnusZlOIU0Yd00,11
-kitikiplot-0.1.5.dist-info/RECORD,,