algokit-py 0.1.0__tar.gz

algokit_py-0.1.0/PKG-INFO

@@ -0,0 +1,52 @@
+Metadata-Version: 2.4
+Name: algokit-py
+Version: 0.1.0
+Summary: A minimal Python algorithms library with clean implementations of search algorithms
+Author: Chanaka Prasanna
+License: MIT
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+
+# 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/README.md

@@ -0,0 +1,40 @@
+# 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

@@ -0,0 +1,8 @@
+"""
+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"]

algokit_py-0.1.0/algokit_py/search/__init__.py

@@ -0,0 +1,4 @@
+from .linear import linear_search
+from .binary import binary_search
+
+__all__ = ["linear_search", "binary_search"]

algokit_py-0.1.0/algokit_py/search/binary.py

@@ -0,0 +1,46 @@
+"""
+The True Minimum Requirements for Binary Search
+Now we can state them precisely:
+- The data must be sorted
+- The data must support random access (you must be able to get the middle element)
+- The elements must be comparable to the target
+
+Every step of binary search answers one question only:
+ - "Which half can I safely throw away without losing the target?"
+
+For binary search, always remember this sentence:
+At every step, the algorithm maintains a range that is guaranteed to contain the target if it exists.
+
+"""
+
+from typing import Sequence, TypeVar
+
+T = TypeVar('T')
+# here we use Sequence because binary seach does not support for unindexed iterables
+def binary_search(sequence: Sequence[T], target: T)-> int:
+    """
+    This function will perform the binary search
+
+    :param sequence: sorted and indexed sequence
+    :param target: value that you want to find
+    :return: return index of a occurrence, -1 if target is not found
+
+
+    Time Complexity: O(log(n))
+    Space Complexity: O(1)
+    """
+
+    left,right = 0, len(sequence)-1
+
+    while left <= right:
+        mid = (left + right) // 2
+
+        if sequence[mid] == target:
+            return mid
+
+        if target < sequence[mid]:
+            right = mid - 1
+        else:
+            left = mid +1
+
+    return -1

algokit_py-0.1.0/algokit_py/search/linear.py

@@ -0,0 +1,19 @@
+from typing import TypeVar, Iterable
+
+T = TypeVar('T')
+def linear_search(iterable: Iterable[T] , target: T)-> int:
+    """
+    This function do linear search.
+
+    :param iterable:
+    :param target:
+    :return:  return index of first occurrence, -1 if target is not found
+
+    Time complexity: O(n)
+    Space complexity: O(1)
+    """
+    for i,v in enumerate(iterable):
+        if v == target:
+            return i
+
+    return -1

algokit_py-0.1.0/algokit_py.egg-info/PKG-INFO

@@ -0,0 +1,52 @@
+Metadata-Version: 2.4
+Name: algokit-py
+Version: 0.1.0
+Summary: A minimal Python algorithms library with clean implementations of search algorithms
+Author: Chanaka Prasanna
+License: MIT
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+
+# 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.egg-info/SOURCES.txt

@@ -0,0 +1,12 @@
+README.md
+pyproject.toml
+algokit_py/__init__.py
+algokit_py.egg-info/PKG-INFO
+algokit_py.egg-info/SOURCES.txt
+algokit_py.egg-info/dependency_links.txt
+algokit_py.egg-info/top_level.txt
+algokit_py/search/__init__.py
+algokit_py/search/binary.py
+algokit_py/search/linear.py
+tests/test_binary.py
+tests/test_linear.py

algokit_py-0.1.0/algokit_py.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

algokit_py-0.1.0/algokit_py.egg-info/top_level.txt

@@ -0,0 +1 @@
+algokit_py

algokit_py-0.1.0/pyproject.toml

@@ -0,0 +1,25 @@
+[build-system]
+requires = ["setuptools>=61.0"]
+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"
+readme = "README.md"
+requires-python = ">=3.9"
+license = {text = "MIT"}
+
+authors = [
+    {name = "Chanaka Prasanna"}
+]
+
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+]
+
+[tool.setuptools.packages.find]
+where = ["."]
+include = ["algokit_py*"]

algokit_py-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

algokit_py-0.1.0/tests/test_binary.py

@@ -0,0 +1,17 @@
+from algokit_py.search import binary_search
+
+
+def test_binary_search_found():
+    assert binary_search([1, 2, 3, 4, 5], 4) == 3
+
+
+def test_binary_search_not_found():
+    assert binary_search([1, 2, 3, 4, 5], 10) == -1
+
+
+def test_binary_search_single_element():
+    assert binary_search([7], 7) == 0
+
+
+def test_binary_search_empty():
+    assert binary_search([], 1) == -1

algokit_py-0.1.0/tests/test_linear.py

@@ -0,0 +1,18 @@
+from algokit_py.search import linear_search
+
+
+def test_linear_search_found():
+    assert linear_search([1, 2, 3, 4], 3) == 2
+
+
+def test_linear_search_not_found():
+    assert linear_search([1, 2, 3, 4], 5) == -1
+
+
+def test_linear_search_empty():
+    assert linear_search([], 1) == -1
+
+
+def test_linear_search_generator():
+    gen = (x for x in [10, 20, 30])
+    assert linear_search(gen, 20) == 1