Metadata-Version: 2.4
Name: kalido
Version: 1.0.0
Summary: A terminal colouriser
Author-email: SurfyGalaxy <surfygalaxy@proton.me>
License: MIT License
        
        Copyright (c) 2026 SurfyGalaxy
        
        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.
        
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: pyyaml
Dynamic: license-file

# Kalido

A python-based colouriser inspired by `lolcat` and `kekcat`, capable of handling both escape sequences and streamed input

## Installation

Kalido is easily downloaded, simply run:
```bash
pip install kalido
```

## Arguments

```bash
--stops <list> # Default = "random"
--count <int> # Default = 5
--size <int> # Default = 1
```
<br><hr><br>

### --stops

Define a list of hex codes which the gradient will go between, or alternatively use a premade template

#### Examples:
  `--stops "#000000" "#FFFFFF"` 
  Creates a gradient between black and white

  `--stops "#FFD800" "#790293" "#FFD800"`
  Creates a gradient between yellow and purple, before returning to yellow

  `--stops aroace`
  Uses the premade gradient of the aroace flag

#### Presets:
- Rainbow
- Lesbian
- Gay (MLM)
- Bisexual
- Transgender
- Queer
- Intersex
- Aroace
- All (Combines every flag end-to-end)
- Random (Will pick any preset)

<hr>

### --count

Define how many additional colours the gradient will have between your stops

Use `0` if you want there to be no additional colours added

<hr>

### --size

Define how many characters each colour will cover.

<br><hr><br>

## Known bugs

- Interactive programs sometimes will leak escape sequences

## AI Disclaimer

No AI was used to generate code nor this README
