Metadata-Version: 2.4
Name: SortCraft
Version: 0.1.4
Summary: A collection of classic and practical sorting algorithms
Author-email: Arijit Kumar Roy <arijitkroy16@gmail.com>
License: MIT License
        
        Copyright (c) 2025 Arijit Kumar Roy
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: Homepage, https://github.com/arijitkroy/sortcraft
Project-URL: Bug Tracker, https://github.com/arijitkroy/sortcraft/issues
Keywords: sorting,algorithms,education,cs
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: License :: OSI Approved :: MIT License
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Libraries
Classifier: Typing :: Typed
Requires-Python: >=3.4
Description-Content-Type: text/markdown
License-File: LICENSE
Dynamic: license-file

<p align="center">
    <img src="https://raw.githubusercontent.com/arijitkroy/sortcraft/main/softcraft.png" alt="sortcraft logo" width="480">
</p>

SortCraft is a comprehensive Python package providing an extensive collection of sorting algorithms suitable for educational, research, and benchmarking purposes. All implementations are type-annotated, documented for clarity, and exposed through a clean flat API for easy import and exploration.

Features
--------
- More than twenty sorting algorithms, including classical, integer/distribution, advanced, parallel, and theoretical types.
- All functions have PEP 484 type annotations and rich, standardized docstrings suitable for IDE/hover documentation and Sphinx autodoc.
- Simple import model: `from sortcraft import merge_sort, quick_sort, cycle_sort, ...`.
- Designed for reliability, readability, and educational use cases as well as algorithmic experimentation.

Installation
------------
Install the latest release from PyPI:

    pip install sortcraft

Or, for the latest development version:

    pip install git+https://github.com/arijitkroy/sortcraft

Quick Usage
-----------

    from sortcraft import merge_sort, heap_sort
    data = [5, 2, 9, 1]
    sorted_data = merge_sort(data)  # [1, 2, 5, 9]

Included Algorithms
-------------------

- Classical comparison sorts: bubble_sort, selection_sort, insertion_sort, merge_sort, quick_sort, heap_sort
- Counting/distribution sorts: counting_sort, radix_sort, pigeonhole_sort, flash_sort, bucket_sort
- Advanced or hybrid: shell_sort, comb_sort, cocktail_sort, timsort, bitonic_sort, cycle_sort
- Educational or theoretical: pancake_sort, gnome_sort, stooge_sort, bogo_sort, odd_even_sort

All functions require a sequence of comparable elements and return a new sorted list.

Type Annotations and Docstring Standards
----------------------------------------
- All user-facing APIs are type-annotated (PEP 484/561 compliant via the included py.typed marker).
- Docstrings follow the Google style, suitable for Sphinx autodoc and IDE hover documentation.
- Each algorithm documents its stability, complexity, and typical usage.

License
-------
SortCraft is licensed under the MIT License. See the LICENSE file for details.

Contributing
------------
Contributions by way of issue reports, algorithm additions, or improvements to documentation are welcome. Please open an issue or submit a pull request on GitHub.
