algokit-py 0.1.0__tar.gz → 0.3.0__tar.gz

{algokit_py-0.1.0 → algokit_py-0.3.0}/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.4
 Name: algokit-py
-Version: 0.1.0
-Summary: A minimal Python algorithms library with clean implementations of search algorithms
+Version: 0.3.0
+Summary: A minimal Python algorithms library with clean implementations of search algorithms and sort algorithms
 Author: Chanaka Prasanna
 License: MIT
 Classifier: Programming Language :: Python :: 3
@@ -12,14 +12,28 @@ Description-Content-Type: text/markdown
 
 # algokit-py
 
-A lightweight Python algorithms library with clean, well-documented implementations.
+A lightweight Python algorithms library with clean, well-documented, and tested implementations.
+Designed for learning, interviews, and real-world algorithm reasoning.
 
 ## Features
+
+### Search Algorithms
 - Linear Search
-- Binary Search
+- Binary Search (iterative, invariant-based)
+
+### Sorting Algorithms
+- Insertion Sort (in-place, stable)
+- Merge Sort (divide-and-conquer, O(n log n))
 
 ## Usage
 
+### Install
+
+```python
+pip install algokit-py
+```
+
+### Search
 ```python
 from algokit_py.search import linear_search, binary_search
 
@@ -27,26 +41,14 @@ print(linear_search([1, 2, 3], 2))
 print(binary_search([1, 2, 3], 2))
 ```
 
+### Sorting
+```python
+from algokit_py.sort import insertion_sort, merge_sort
 
-We will improve this later.
-
----
-
-## STEP 6: Local Install Test (Very Important)
-
-From **project root**:
-
-```powershell
-pip install -e .
-```
-
-Then test:
+data = [3, 1, 2]
 
-```powershell
-python -c "from algokit_py.search import binary_search; print(binary_search([1,2,3], 2))"
-```
+insertion_sort(data)
+print(data)  # [1, 2, 3]
 
-You must see:
-```python
-1
+print(merge_sort([3, 1, 2]))  # [1, 2, 3]
 ```

algokit_py-0.3.0/README.md

@@ -0,0 +1,42 @@
+# algokit-py
+
+A lightweight Python algorithms library with clean, well-documented, and tested implementations.
+Designed for learning, interviews, and real-world algorithm reasoning.
+
+## Features
+
+### Search Algorithms
+- Linear Search
+- Binary Search (iterative, invariant-based)
+
+### Sorting Algorithms
+- Insertion Sort (in-place, stable)
+- Merge Sort (divide-and-conquer, O(n log n))
+
+## Usage
+
+### Install
+
+```python
+pip install algokit-py
+```
+
+### Search
+```python
+from algokit_py.search import linear_search, binary_search
+
+print(linear_search([1, 2, 3], 2))
+print(binary_search([1, 2, 3], 2))
+```
+
+### Sorting
+```python
+from algokit_py.sort import insertion_sort, merge_sort
+
+data = [3, 1, 2]
+
+insertion_sort(data)
+print(data)  # [1, 2, 3]
+
+print(merge_sort([3, 1, 2]))  # [1, 2, 3]
+```

algokit_py-0.3.0/algokit_py/__init__.py

@@ -0,0 +1,8 @@
+"""
+algokit_py - A minimal Python algorithms library
+"""
+
+from algokit_py.search import binary_search, linear_search
+from algokit_py.sort import insertion_sort, merge_sort
+
+__all__ = ["binary_search", "linear_search","insertion_sort","merge_sort"]

{algokit_py-0.1.0 → algokit_py-0.3.0}/algokit_py/search/binary.py

@@ -16,10 +16,11 @@ At every step, the algorithm maintains a range that is guaranteed to contain the
 from typing import Sequence, TypeVar
 
 T = TypeVar('T')
-# here we use Sequence because binary seach does not support for unindexed iterables
+# here we use Sequence because binary search does not support for not indexed iterables.
+# Binary search requires a sorted sequence.
 def binary_search(sequence: Sequence[T], target: T)-> int:
     """
-    This function will perform the binary search
+    This function will perform the binary search. Sequence must be a sorted sequence
 
     :param sequence: sorted and indexed sequence
     :param target: value that you want to find

algokit_py-0.3.0/algokit_py/sort/__init__.py

@@ -0,0 +1,4 @@
+from .insertion import insertion_sort
+from .merge import merge_sort
+
+__all__ = ["insertion_sort", "merge_sort"]

algokit_py-0.3.0/algokit_py/sort/insertion.py

@@ -0,0 +1,26 @@
+from typing import MutableSequence, TypeVar
+
+T = TypeVar('T')
+def insertion_sort(sequence: MutableSequence[T])-> None:
+    """
+    At the start of iteration i, the subarray sequence[0:i] is sorted.
+
+    :param Mutable sequence
+    :return None
+
+    Worst Case Time Complexity: O(n²)
+    Space Complexity: O(1)
+    """
+    length = len(sequence)
+    for i in range(1, length):
+        key = sequence[i]
+        j = i-1
+        while sequence[j] > key and j >= 0:
+            sequence[j+1]= sequence[j]
+            j -= 1
+        sequence[j + 1] = key
+
+
+
+
+

algokit_py-0.3.0/algokit_py/sort/merge.py

@@ -0,0 +1,43 @@
+from typing import Sequence, TypeVar
+
+T = TypeVar('T')
+
+def merge_sort(sequence: Sequence[T]) -> list[T]:
+    """
+    Merge sort implementation.
+
+    Base case:
+    - Sequences of length 0 or 1 are already sorted.
+
+    Worst Case Time Complexity: O(n log n)
+    Space Complexity: O(n)
+    """
+    if len(sequence) <= 1:
+        return list(sequence)
+
+    middle = len(sequence) // 2
+    left = sequence[:middle]
+    right = sequence[middle:]
+
+    sorted_left = merge_sort(left)
+    sorted_right = merge_sort(right)
+
+    merged = []
+    i = j = 0
+
+    while i < len(sorted_left) and j < len(sorted_right):
+        if sorted_left[i] <= sorted_right[j]:
+            merged.append(sorted_left[i])
+            i += 1
+        else:
+            merged.append(sorted_right[j])
+            j += 1
+
+    merged.extend(sorted_left[i:])
+    merged.extend(sorted_right[j:])
+
+    return merged
+
+
+
+

{algokit_py-0.1.0 → algokit_py-0.3.0}/algokit_py.egg-info/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.4
 Name: algokit-py
-Version: 0.1.0
-Summary: A minimal Python algorithms library with clean implementations of search algorithms
+Version: 0.3.0
+Summary: A minimal Python algorithms library with clean implementations of search algorithms and sort algorithms
 Author: Chanaka Prasanna
 License: MIT
 Classifier: Programming Language :: Python :: 3
@@ -12,14 +12,28 @@ Description-Content-Type: text/markdown
 
 # algokit-py
 
-A lightweight Python algorithms library with clean, well-documented implementations.
+A lightweight Python algorithms library with clean, well-documented, and tested implementations.
+Designed for learning, interviews, and real-world algorithm reasoning.
 
 ## Features
+
+### Search Algorithms
 - Linear Search
-- Binary Search
+- Binary Search (iterative, invariant-based)
+
+### Sorting Algorithms
+- Insertion Sort (in-place, stable)
+- Merge Sort (divide-and-conquer, O(n log n))
 
 ## Usage
 
+### Install
+
+```python
+pip install algokit-py
+```
+
+### Search
 ```python
 from algokit_py.search import linear_search, binary_search
 
@@ -27,26 +41,14 @@ print(linear_search([1, 2, 3], 2))
 print(binary_search([1, 2, 3], 2))
 ```
 
+### Sorting
+```python
+from algokit_py.sort import insertion_sort, merge_sort
 
-We will improve this later.
-
----
-
-## STEP 6: Local Install Test (Very Important)
-
-From **project root**:
-
-```powershell
-pip install -e .
-```
-
-Then test:
+data = [3, 1, 2]
 
-```powershell
-python -c "from algokit_py.search import binary_search; print(binary_search([1,2,3], 2))"
-```
+insertion_sort(data)
+print(data)  # [1, 2, 3]
 
-You must see:
-```python
-1
+print(merge_sort([3, 1, 2]))  # [1, 2, 3]
 ```

{algokit_py-0.1.0 → algokit_py-0.3.0}/algokit_py.egg-info/SOURCES.txt

@@ -8,5 +8,10 @@ algokit_py.egg-info/top_level.txt
 algokit_py/search/__init__.py
 algokit_py/search/binary.py
 algokit_py/search/linear.py
+algokit_py/sort/__init__.py
+algokit_py/sort/insertion.py
+algokit_py/sort/merge.py
 tests/test_binary.py
-tests/test_linear.py
+tests/test_insertion.py
+tests/test_linear.py
+tests/test_merge.py

{algokit_py-0.1.0 → algokit_py-0.3.0}/pyproject.toml

@@ -4,8 +4,8 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "algokit-py"
-version = "0.1.0"
-description = "A minimal Python algorithms library with clean implementations of search algorithms"
+version = "0.3.0"
+description = "A minimal Python algorithms library with clean implementations of search algorithms and sort algorithms"
 readme = "README.md"
 requires-python = ">=3.9"
 license = {text = "MIT"}

algokit_py-0.3.0/tests/test_insertion.py

@@ -0,0 +1,32 @@
+
+from algokit_py.sort import insertion_sort
+
+
+def test_insertion_sort_basic():
+    data = [3, 1, 2]
+    insertion_sort(data)
+    assert data == [1, 2, 3]
+
+
+def test_insertion_sort_already_sorted():
+    data = [1, 2, 3, 4]
+    insertion_sort(data)
+    assert data == [1, 2, 3, 4]
+
+
+def test_insertion_sort_reverse():
+    data = [4, 3, 2, 1]
+    insertion_sort(data)
+    assert data == [1, 2, 3, 4]
+
+
+def test_insertion_sort_single_element():
+    data = [5]
+    insertion_sort(data)
+    assert data == [5]
+
+
+def test_insertion_sort_empty():
+    data = []
+    insertion_sort(data)
+    assert data == []

algokit_py-0.3.0/tests/test_merge.py

@@ -0,0 +1,25 @@
+from algokit_py.sort import merge_sort
+
+
+def test_merge_sort_basic():
+    assert merge_sort([3, 1, 2]) == [1, 2, 3]
+
+
+def test_merge_sort_already_sorted():
+    assert merge_sort([1, 2, 3, 4]) == [1, 2, 3, 4]
+
+
+def test_merge_sort_reverse():
+    assert merge_sort([4, 3, 2, 1]) == [1, 2, 3, 4]
+
+
+def test_merge_sort_single_element():
+    assert merge_sort([5]) == [5]
+
+
+def test_merge_sort_empty():
+    assert merge_sort([]) == []
+
+
+def test_merge_sort_duplicates():
+    assert merge_sort([3, 1, 2, 1]) == [1, 1, 2, 3]

algokit_py-0.1.0/README.md

@@ -1,40 +0,0 @@
-# algokit-py
-
-A lightweight Python algorithms library with clean, well-documented implementations.
-
-## Features
-- Linear Search
-- Binary Search
-
-## Usage
-
-```python
-from algokit_py.search import linear_search, binary_search
-
-print(linear_search([1, 2, 3], 2))
-print(binary_search([1, 2, 3], 2))
-```
-
-
-We will improve this later.
-
----
-
-## STEP 6: Local Install Test (Very Important)
-
-From **project root**:
-
-```powershell
-pip install -e .
-```
-
-Then test:
-
-```powershell
-python -c "from algokit_py.search import binary_search; print(binary_search([1,2,3], 2))"
-```
-
-You must see:
-```python
-1
-```

algokit_py-0.1.0/algokit_py/__init__.py

@@ -1,8 +0,0 @@
-"""
-algokit_py - A minimal Python algorithms library
-"""
-
-from algokit_py.search import binary_search, linear_search
-
-__version__ = "0.1.0"
-__all__ = ["binary_search", "linear_search"]