Metadata-Version: 2.4
Name: funsort
Version: 1.0.1
Summary: Fun sorting algorithms in Python!
Author: Derek Li
License-Expression: MIT
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Dynamic: license-file

# funsort

A little Python package with fun sorting algorithms. 
Perfect if you would like a simple way to explore and compare various sorting algorithms, 
or if you just want to make your programs less efficient for no reason.

### Important!

If you are reading this on PyPI, please note that this README was meant to be viewed
with references to the project files. For a better experience, please view the README on GitHub
by clicking [here](https://github.com/DairyProducts/funsort/).

## Usage

For a list of supported algorithms, see [ALGORITHMS.md](ALGORITHMS.md).

You can import a specific sorting function and use it to sort a list. 
For example, to use the `bubble_sort` function:
```python
from funsort import bubble_sort

data = [3, 1, 2]
print(bubblesort(data))
```

This will output:

```
[1, 2, 3]
```

You can also import the package of all prim-and-proper sorting algorithms and use any 
of the available functions. For example:

```python
from funsort import Proper
data = [3, 1, 2]
print(Proper.bubble_sort(data))
```

Likewise, with the esoteric sorting algorithms:

```python
from funsort import Esoteric
data = [3, 1, 2]
print(Esoteric.bogo_sort(data))
```

## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
