flavortui 1.0.1

Feature-rich terminal UI for Flavortown: devlogs, projects, shop, and more.

FlavorTUI

FlavorTUI is a feature-rich terminal user interface (TUI) for Flavortown. With FlavorTUI, you can browse and create devlogs, manage your projects, explore the shop, and access other Flavortown features, all from an interactive terminal interface.

It is built using the textual library, which provides (imo) a great terminal UI experience. The TUI is of course written in Python 🥰. This is my first time creating a TUI so I hope its good :) Depending on your terminal, the ui might look different. It all depends on how well your terminal supports different things.

Your API key is stored "securely" using the keyring library, so you don't have to worry about it being exposed in your terminal history or config files.

Storage Locations

FlavorTUI stores data in three places:

• API key: system keychain/keyring (via keyring)
• Settings JSON: user config directory (via platformdirs.user_config_dir("flavortui"))
• API/image cache: user cache directory (via platformdirs.user_cache_dir("flavortui"))

Typical paths:

To easily find where your data is stored, you can simply go to the bottom of the settings menu and click on the associated buttons!

• macOS:
  • Settings: ~/Library/Application Support/flavortui/settings.json
  • Cache: ~/Library/Caches/flavortui/
• Windows:
  • Settings: %LOCALAPPDATA%\\flavortui\\settings.json
  • Cache: %LOCALAPPDATA%\\flavortui\\Cache\\
• Linux:
  • Settings: ~/.config/flavortui/settings.json (or $XDG_CONFIG_HOME/flavortui/settings.json)
  • Cache: ~/.cache/flavortui/ (or $XDG_CACHE_HOME/flavortui/)

Installation

pip install flavortui

Local Development

python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate
pip install -e .

Run with either:

flavortui

or:

python -m flavortui

API

Flavortown API docs can be found here.

License

flavortui is distributed under the terms of the MIT license.