Metadata-Version: 2.4
Name: luciditycli
Version: 0.1.2
Summary: Simple module for aesthetic CLI interfaces
License-Expression: GPL-3.0-only
License-File: LICENSE
Requires-Python: >=3.12
Description-Content-Type: text/markdown

# 🌘 lucidity

> the clarity of intelligence in a piece of work

> [!IMPORTANT]
> This repository contains both Lucidity and a demo making use of it. You must install Lucidity as a library to use the demo. view the demo's readme [here](demo.md)


## what?
`lucidity` is a Python library designed to make minimal yet aesthetic CLI programs.

## how?
a fairly exhaustive feature list-
- theming system
    - load themes from a file, persist between sessions
    - create new themes
    - comes with multiple premade themes
    - reference theme colors easily
- storage system
    - easily save and load config information to disk without using a config library
- box drawing tools
- buffer system
- input listening
- hotkeys

- works on all terminal emulators

## ok but how?
[RTFM](TFM.md)

## ok but like seriously how?
> [!WARNING]
> use `pipx` if your system tells you to! for example, Arch Linux

install the library: `pip install lucidity`
install the demo: `pip install TODO ADD`

run the demo: `ADD LATER`

## why?
https://siege.hackclub.com