https://github.com/dee-me-tree-or-love/kalimba
A MacOS menu bar app to control Colima CLI. 🐳
https://github.com/dee-me-tree-or-love/kalimba
cli colima macos menubar-app monitor
Last synced: 3 months ago
JSON representation
A MacOS menu bar app to control Colima CLI. 🐳
- Host: GitHub
- URL: https://github.com/dee-me-tree-or-love/kalimba
- Owner: dee-me-tree-or-love
- License: mit
- Created: 2023-08-17T11:25:38.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-08-20T12:13:56.000Z (10 months ago)
- Last Synced: 2025-02-01T07:28:08.754Z (5 months ago)
- Topics: cli, colima, macos, menubar-app, monitor
- Language: Python
- Homepage:
- Size: 86.9 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 🐳 `Kalimba` == `Co'li`ma `M`enu `Ba`r
> 🌱 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`](https://github.com/abiosoft/colima) with a basic GUI
written using [`rumps`](https://github.com/jaredks/rumps).
## Usage
### Start the `kalimba` menu bar app
```bash
$ kalimba
INFO:kalimba.kalimba:Starting the kalimba app... 🎶
...
```
> 🧙 and it launches the `kalimba` 🐳 application! ✨
>
> 
### Getting `kalimba` help
```bash
$ kalimba --help
Usage: kalimba [OPTIONS] ...
```
## Installation
### Give it a local try
Starting right away using [`poetry`](https://python-poetry.org/):
```bash
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
```bash
$ poetry build
Building kalimba ()
...
- Built kalimba--.tar.gz
...
```
2. Check build results:
```bash
$ ls ./dist
...
kalimba--.tar.gz
...
```
3. Install the local `tar` file:
> Don't forget to replace the `` to the built result. 💡
```bash
$ pip install --user ./dist/kalimba--.tar.gz
...
Successfully installed ... kalimba- ...
```
4. Check direct access to `kalimba` CLI
```bash
$ kalimba --help
Usage: kalimba [OPTIONS]
...
```
Using pypiserver 🏕️
#### Install via (local) [pypiserver](https://github.com/pypiserver/pypiserver)
1. Start the local [`pypi-server`](https://github.com/pypiserver/pypiserver)
> 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. ✌️
```bash
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. 🔁
```bash
poetry config repositories.local http://localhost
```
3. Build and publish the project
```bash
$ poetry build
Building kalimba ()
...
- Built kalimba--...
$ poetry publish -r local
Publishing kalimba () to local
...
$ pip install --user -i http://localhost/ kalimba
...
Successfully installed ... kalimba- ...
```
4. Check direct access to `kalimba` CLI
```bash
$ kalimba --help
Usage: kalimba [OPTIONS]
...
```