Metadata-Version: 2.1
Name: franky-theme
Version: 2.3.0
Summary: Franky colour theme library.
Keywords: color,colour,theme,palette,scheme,terminal
Author-Email: Gilles Coissac <gilles@ideographe.fr>
License: GPL-3.0
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Typing :: Typed
Project-URL: homepage, https://github.com/gravures/franky/
Project-URL: repository, https://github.com/gravures/franky/
Project-URL: documentation, https://github.com/gravures/franky/
Project-URL: issue, https://github.com/gravures/franky/issues
Project-URL: Changelog, https://github.com/gravures/franky/releases
Requires-Python: >=3.11
Requires-Dist: standard-deluxe
Requires-Dist: pretty-errors
Description-Content-Type: text/markdown

# Franky

![Python Version from PEP 621 TOML](https://img.shields.io/python/required-version-toml?tomlFilePath=https%3A%2F%2Fraw.githubusercontent.com%2Fgravures%2Ffranky%2Fmain%2Fpyproject.toml) ![GitHub License](https://img.shields.io/github/license/gravures/standard-deluxe) ![OS support](https://img.shields.io/badge/OS-macOS%20Linux%20Windows-red) ![downloads](assets/downloads.svg)

A **GitHub-Dark-inspired** coding palette fused with the UI flavor of **Catppuccin-Mocha**. **Franky** works well alongside **Catppuccin** dark themes when the former are not available for a given application.

## Preview

![Franky](assets/franky.png)

## Installation

**Franky** comes with a Python installer. The preferred way to install the CLI is using [UV](https://docs.astral.sh/uv/):

```bash
uv tool install franky-theme
```

Alternatively, you can use [PIPX](https://pipx.pypa.io/stable/):

```bash
pipx install franky-theme
```

## Usage

Most themes are simple config files generated on demand by the CLI and installed in preconfigured locations. Some themes — like **IPython** — have a specific installation procedure.

```bash
$ franky install ghostty
```

![Terminal](assets/term.gif)

### IPython Theme

**Franky-IPython** theme is available as an *extension* on **PyPi**. IPython typically stores its configurations in the `~/.ipython` directory. One way to provide this theme to IPython is by installing this *extension* under `~/.ipython/extensions/`. This can be done with **UV** as follows:

```bash
uv pip install --target="$HOME/.ipython/extensions" franky-ipython
```

Then add the following lines to `~/.ipython/profile_default/ipython_config.py`:

```python

import sys
from pathlib import Path

sys.path.append(str(Path.home() / ".ipython" / "extensions"))
c.InteractiveShellApp.extensions.append("franky_ipython")
```

![ipython](assets/ipy.gif)

## Themes Roadmap

- [x] Bat
- [x] Delta
- [x] Diffnav (supported via Delta)
- [x] Ghostty
- [x] Helix editor
- [x] IPython shell
- [x] Kitty
- [x] Lazygit
- [x] Qman
- [x] Yazi
- [ ] OpenCode
- [ ] Neovim
- [ ] Emacs
- [ ] Zed
- [ ] VsCode
- [ ] Gtk.SourceView
- [ ] shell: LS_COLORS + man colors + ncurse colors
- [ ] Tmux
- [ ] Zellij
- [ ] Glow
- [ ] CSS
- [ ] Gnome Shell

## Contributing

Contributors are always welcome. Feel free to grab an [issue](https://github.com/gravures/franky/issues) to work on or make a suggested improvement. If you wish to contribute, please read the [Contribution Guide](https://github.com/gravures/franky/blob/main/CONTRIBUTING.md) and [Code of Conduct](https://github.com/gravures/franky/blob/main/CODE_OF_CONDUCT.md). <!-- rumdl-disable-line MD013 -->

## License

Use of this repository is authorized under the [GPL-3.0](https://github.com/gravures/franky/blob/main/LICENSE).
