Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/dormant-chicken/sortty

sortty - sorting algorithms in the terminal
https://github.com/dormant-chicken/sortty

bash ncurses python shell sorting sorting-algorithms sortty terminal

Last synced: 26 days ago
JSON representation

sortty - sorting algorithms in the terminal

Awesome Lists containing this project

README 

        
# sortty



sortty - sorting algorithms in the terminal



## Gallery



![quicksort3](https://github.com/dormant-chicken/sortty/blob/main/assets/quicksort3.png)



 



![quicksort3](https://github.com/dormant-chicken/sortty/blob/main/assets/quicksort4.png)







## Table of contents



* [Main Features](https://github.com/dormant-chicken/sortty?tab=readme-ov-file#main-features)



* [AUR](https://github.com/dormant-chicken/sortty?tab=readme-ov-file#aur)



* [Dependencies](https://github.com/dormant-chicken/sortty?tab=readme-ov-file#dependencies)



* [Installation](https://github.com/dormant-chicken/sortty?tab=readme-ov-file#installation)



    * [Latest git](https://github.com/dormant-chicken/sortty?tab=readme-ov-file#latest-git)



    * [Stable release](https://github.com/dormant-chicken/sortty?tab=readme-ov-file#stable-release)



* [Last step of install](https://github.com/dormant-chicken/sortty?tab=readme-ov-file#last-step-of-install)



* [Trying sortty without installing](https://github.com/dormant-chicken/sortty/tree/main?tab=readme-ov-file#trying-sortty-without-installing)



* [Usage](https://github.com/dormant-chicken/sortty?tab=readme-ov-file#usage)



* [Uninstalling](https://github.com/dormant-chicken/sortty?tab=readme-ov-file#uninstalling)



* [The name](https://github.com/dormant-chicken/sortty?tab=readme-ov-file#the-name)







## Main Features



- Currently has 21 built-in sorting algorithms

- Auto-adjusts if terminal is resized

- Animations before and after sorting array

- Shows index while sorting array

- Plays sound depending on index when sorting



More features are in the [usage](https://github.com/dormant-chicken/sortty?tab=readme-ov-file#usage) tab of the README







## Flashing Light Warning



> [!WARNING]

> There may be flashing on the screen if text-only mode is not used, if the terminal text is small, or if the bar size is small. This can be fixed by lowering the size of your terminal, increasing the size of the bars, increasing terminal font size, or increasing the wait delay for the program, but the best solution I found is to use a lightweight terminal such as [st](https://wiki.archlinux.org/title/st) if you use Xorg or [foot](https://wiki.archlinux.org/title/Foot) if you use Wayland







## AUR



If you don't want to install sortty manually, sortty is available on the AUR [here](https://aur.archlinux.org/packages/sortty)







## Dependencies



These dependencies are needed:



* `python`

* `ncurses`

* `git`

* `portaudio`

* `pip`



These pip dependencies are also needed:



* `pysine`



Arch:

```

sudo pacman -S python ncurses git portaudio python-pip

```



Fedora:

```

sudo dnf install python ncurses ncurses-devel git portaudio python3-pip

```



Debian:

```

sudo apt install python3 libncurses6 libncurses-dev git portaudio19-dev python3-pip

```



Gentoo:

```

sudo emerge --ask dev-lang/python sys-libs/ncurses dev-vcs/git media-libs/portaudio dev-python/pip

```



openSUSE:

```

sudo zypper install python3 ncurses git portaudio python3-pip

```







To install pip dependencies:



```

pip install pysine

```







## Installation



### Latest git



After installing the needed dependencies, clone this repository to get the very latest git release:



```

git clone https://github.com/dormant-chicken/sortty

```



### Stable release



If you want the stable release, install the dependencies above and use wget to get the tar.gz file from the releases page:



```

wget https://github.com/dormant-chicken/sortty/releases/latest/download/sortty.tar.gz

```







Or you can also get it with a web browser from the [releases page](https://github.com/dormant-chicken/sortty/releases)







Then, you can decompress the tar.gz file by typing:



```

tar -xzvf sortty.tar.gz

```







If you want to use a file manager instead, right click on the tar.gz file and click extract or extract here







You can remove the tar.gz file if you want to:



```

rm sortty.tar.gz

```







You can also remove it in your file manager, but rest of the instructions will need the terminal







## Last step of install



Finally, change your directory into sortty/, make installation script executable, and run it:



```

cd sortty/

chmod +x install.sh

./install.sh

```







After installing, you can remove the sortty/ directory, as the needed files are already copied to the correct paths:



```

cd ..

rm -rvf sortty/

```



This command also changes your directory to the parent directory of sortty/ with 'cd ..' so that it can remove the installation files







## Trying sortty without installing



If you just want to try sortty without installing, the program has support for that



Just get the files by using git to clone this repostory (shown in the [latest git](https://github.com/dormant-chicken/sortty?tab=readme-ov-file#latest-git) tab) or get the latest stable release and decompress it (shown in the [stable release](https://github.com/dormant-chicken/sortty?tab=readme-ov-file#stable-release) tab). Then, run this command to go into the sortty directory and make the program executable:



```

cd sortty/

chmod +x src/sortty.py

```



Then, run this to execute the program:



```

src/sortty.py

```







After trying sortty, you can still install it (shown in the [last step of install](https://github.com/dormant-chicken/sortty?tab=readme-ov-file#last-step-of-install) tab) without any problems







## Usage







Example command:



```

sortty

```



Use these arguments to change how the program behaves:



```

[-h --help] shows help message



[-t --text] add this to make the program use text-only mode instead of using fancy bars



[-i --info] is off, meaning it will not show the sorting information after sorting



[-nf --no_fill] is off, meaning it will not fill the array after sorting



[-ni --no_index] when used, does not show the index as a red bar if (or as a '@' character if --text is enabled) when sorting



[-na --no_animation] when used, does not show fill and shuffle animation before sorting



[-ns --no_sound] disables playing sound depending on current index



[-sp --sound_pitch] default is 30, increasing it will increase the pitch depending on current index, does nothing if --no_sound is used



[-bs --bar_size] is 1, meaning the program will display the bars with a width of 1 terminal characters



[-d --delay] is 75, meaning the program will wait 75ms before refreshing the screen



[-ad --animation_delay] if not specified, the program will wait wait a dynamic amount of time based on the size of the array before refreshing animations



[-a --algorithm] is 'quick', meaning the program will use the quicksort algorithm to sort the array



[-bc --bar_color] changes color of bars when sorting, does nothing if --text is used



[-ic --index_color] changes color of index pointer when sorting, does nothing if --text is used



[-fc --fill_color] changes color that fills the array after sorting, does nothing if --text is used



[-bch --bar_character] changes character for the bars when sorting, does nothing if --text is not used



[-ich --index_character] changes character for the index pointer when sorting, does nothing if --text is not used



[-fch --fill_character] changes character that fills the array after sorting, does nothing if --text is not used



[-s --size] if not specified, size will be depending from the screen size, otherwise you can do HEIGTHxWIDTH, for example 30x20



[-v --version] print version and quit

```



Available algorithms: bogo bubble merge insertion quick gnome heap cocktail selection shell oddeven comb bingo radix pigeonhole pancake bead stooge inplace_merge tim circle



Available colors for bars: red green blue cyan magenta yellow white transparent



Here is another example command, but with arguments:



```

sortty --algorithm insertion --text --bar_character o

```



The command above runs sortty with the insertion sort algorithm, sets text-only mode to true, and makes the program use an 'o' character instead of the default '#' character for the bars



Note: you can set the algorithm to 'forever' like this:



```

sortty --algorithm forever

```



Setting it to forever makes the program shuffle the array and sort it with a random algorithm forever (excluding bogo sort)







## Uninstalling



Run this command to remove the program:



```

rm ~/.local/bin/sortty

```



Optionally, you can also remove this line from your shell rc file (located in '\~/.basrc' if you use bash or '\~/.zshrc' if you use zsh):



```

export PATH=$PATH:$HOME/.local/bin

```







## The Name



The name is the word "sort", because this is a program to visualize sorting algorithms, plus the word "TTY", which is similar to a terminal. "sort" plus "TTY" equals "sortty", it's a great name, I know.