Metadata-Version: 2.1
Name: sh40-zenith
Version: 0.0.2
Summary: A markup language and color palette generators targeting the terminal.
Project-URL: Documentation, https://github.com/shade40/zenith#readme
Project-URL: Issues, https://github.com/shade40/zenith#issues
Project-URL: Source, https://github.com/shade40/zenith
Author-email: bczsalba <bczsalba@gmail.com>
License-Expression: MIT
License-File: LICENSE.txt
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Requires-Python: >=3.8
Requires-Dist: sh40-slate
Description-Content-Type: text/markdown

![zenith](https://singlecolorimage.com/get/4A7A9F/1600x200)

## zenith

A markup language and color palette generators targeting the terminal.

```
pip install zenith
```

![rule](https://singlecolorimage.com/get/4A7A9F/1600x5)

### Purpose

The primary usecase for Zenith is to color and style text in the terminal. We do this through 2 connected systems, our markup language and palette generation.

We use a [BBCode](https://en.wikipedia.org/wiki/BBCode) inspired markup language, where you define tag _groups_, and specific styles within each group. Every tag is independent of others, so you can set and unset single styles easily. We also support custom tag aliases, macro functions and more!

```
Welcome to [bold #4A7A9F]Zenith[/fg]!
```

Our palette generator applies color theory to generate a nice, aesthetically pleasing and UX-optimized color palette from any primary color. You can optionally get a palette aliased, so you can use shades derived from its colors:

```python
from zenith import Palette, markup

palette = Palette.from_hex("#4A7A9F")
palette.alias()
print(markup(palette.render()))

print(markup("[primary-2]Primary foreground color, darkened twice"))
```

![result](https://github.com/shade40/zenith/blob/main/assets/readme_purpose_1.png?raw=true)

![rule](https://singlecolorimage.com/get/4A7A9F/1600x5)

### Examples
