README.md

🐳 Kalimba == Co'lima Menu Bar

🌱 This is an early WIP, more information coming soon ✨

kalimba is a tiny menu bar application allowing to monitor and toggle the status of colima with a basic GUI written using rumps.

Usage

Start the kalimba menu bar app

$ kalimba
INFO:kalimba.kalimba:Starting the kalimba app... 🎶
...

🧙 and it launches the kalimba 🐳 application! ✨

Getting kalimba help

$ kalimba --help
Usage: kalimba [OPTIONS] ...

Installation

Give it a local try

Starting right away using poetry:

poetry install # installs kalimba in poetry's environment
poetry run kalimba --help # shows some tips-and-tricks
poetry run kalimba # starts the app

More temporary installation options 👀

Using local build 🪵

Install local build directly

1. Build the project

   $ poetry build
   Building kalimba (<version>)
    ...
    - Built kalimba-<version>-.tar.gz
    ...

2. Check build results:

   $ ls ./dist
   ...
   kalimba-<version>-.tar.gz
   ...

3. Install the local tar file:

   Don't forget to replace the <version> to the built result. 💡

   $ pip install --user ./dist/kalimba-<version>-.tar.gz
   ...
   Successfully installed ... kalimba-<version> ...

4. Check direct access to kalimba CLI

   $ kalimba --help
   
   Usage: kalimba [OPTIONS]
   ...

Using pypiserver 🏕️

Install via (local) pypiserver

1. Start the local pypi-server

   This guide shows how to use a locally running pypiserver.
   Feel free to skip to the next step if you already have one running elsewhere. ✌️

   docker run --rm -p 80:8080 pypiserver/pypiserver:latest run -P . -a . -vvv

2. Configure poetry:

   If you would like to use a remotely deployed one, feel free to adjust the pypiserver URLs here and further. 🔁

   poetry config repositories.local http://localhost 

3. Build and publish the project

   $ poetry build
   Building kalimba (<version>)
    ...
    - Built kalimba-<version>-...
   $ poetry publish -r local
   Publishing kalimba (<version>) to local
   ...
   $ pip install --user -i http://localhost/ kalimba
   ...
   Successfully installed ... kalimba-<version> ...

4. Check direct access to kalimba CLI

   $ kalimba --help
   
   Usage: kalimba [OPTIONS]
   ...