davideferigato/lumix repository overview

⁠🔄 Lumix

One CLI to convert everything – from temperature to Morse code, in 5 languages.

Lumix is a modular, multilingual command-line converter for physical units, digital data, time, security tools, and creative utilities. Designed to be easily extensible, it features shell autocompletion – all in one sleek package.

🌐 Supported languages: English, Italian, French, Spanish, Japanese. ⚙️ Modular core: add your own converters in minutes.

⁠📋 Table of contents

• ✨ Features⁠
• 🤔 Why Lumix?⁠
• 📦 Installation⁠
• 🚀 Basic Usage⁠
• 📊 Complete converter reference (30+ categories)⁠
• ⏩ Shell Autocompletion⁠
• 🐳 Docker⁠
• 🧪 Testing⁠
• 🙏 Acknowledgements⁠

⁠✨ Features

• 🌍 Multilingual by design – Use Lumix in your native language (en, it, fr, es, jp).
• 🧩 Modular architecture – Each converter is independent; adding a new one is as simple as creating a new folder.
• 🚀 Rich set of converters – From physical units to digital data, from time zones to creative tools (see reference table⁠).
• ⌨️ Shell autocompletion – Works with bash and zsh via argcomplete.
• 🐳 Docker‑ready – Run Lumix anywhere without installing dependencies.
• 🧪 Fully tested – High test coverage with pytest.

⁠🤔 Why Lumix instead of units or qalc?

Lumix is not just another unit converter – it's a pluggable framework for CLI conversions, designed to be extended by developers and used by anyone in their native language.

⁠📦 Installation

⁠From PyPI (recommended)

pip install lumix

⁠From source

git clone https://github.com/davideferigato/lumix.git
cd lumix
python -m venv venv && source venv/bin/activate   # or `venv\Scripts\activate` on Windows
pip install --upgrade pip
pip install -e .

⁠🚀 Basic Usage

lumix --help

Lumix follows a simple pattern:

lumix <language> <converter> from <source> to <target> <value>

For example:

lumix en temperature from C to F 36.5
lumix it temperatura da C a F 36,5      # Italian uses comma as decimal separator

⁠📊 Complete converter reference (30+ categories)

⁠⏩ Shell Autocompletion

Lumix integrates with argcomplete to provide smart tab completion.

pip install argcomplete
eval "$(register-python-argcomplete lumix)"
# Add the eval line to your ~/.bashrc or ~/.zshrc to make it permanent

⁠🐳 Docker

Run Lumix in a container without any local installation:

docker build -t lumix .
docker run --rm lumix en temperature from C to F 36.5

⁠🧪 Testing

We use pytest for unit tests. To run the full suite:

pytest tests/

Each module has its own test file (test_<module>.py) to ensure reliability.

⁠🙏 Acknowledgements

• Frankfurter API⁠ for real‑time exchange rates.
• argcomplete⁠ for shell completion magic.