A reusable tkinter/ttkbootstrap UI framework
Project description
Jabs Mimir
Jabs Mimir is a lightweight, extensible UI micro-framework built on top of tkinter and ttkbootstrap, designed for rapid internal tool development and structured form workflows.
It provides:
- Reusable UI primitives with validation and tooltips
- Support for block-based form components with dynamic variable binding
- Integration with custom validation logic
- Modular architecture suitable for internal tooling and small boilerplate projects
Installation
pip install jabs-mimir
Quick Start
from jabs_mimir import Mimir, DataBlockWrapper, UtilityModule
import tkinter as tk
import ttkbootstrap as tb
class App(tb.Window):
def __init__(self):
super().__init__(title="Mimir Demo")
self.ui = Mimir(self)
self.ui.setValidatorResolver(lambda name: {"not_empty": lambda val: bool(val.strip())}.get(name))
self.ui.switchView(self.mainView)
def mainView(self, ui, *args):
frame = tb.Frame(self)
fields = [
{"type": "heading", "label": "Basic Info"},
{"label": "Name", "key": "name", "variable": tk.StringVar(), "validation": "not_empty"},
{"label": "Age", "key": "age", "variable": tk.IntVar()}
]
meta = UtilityModule.buildBlockMeta(fields)
block = DataBlockWrapper(meta)
ui.renderFields(frame, fields)
ui.addNextButton(frame, row=len(fields)+1, command=lambda: print(UtilityModule.getBlockValues(block)))
return frame
if __name__ == "__main__":
app = App()
app.mainloop()
Components
Mimir
Manages UI views, tooltips, validation, field rendering, and form logic.
DataBlockWrapper
A wrapper for block-level form metadata and values. Supports dot-access and .get()/.set() calls.
UtilityModule
Helper methods for building field metadata, extracting values, validating blocks, etc.
License
MIT License © 2025 William Lydahl
📘 API Documentation
Module jabs_mimir.DataBlockWrapper
DataBlockWrapper: A flexible wrapper for structured UI data blocks.
??? example "View Source" """
DataBlockWrapper: A flexible wrapper for structured UI data blocks.
"""
class DataBlockWrapper:
def __init__(self, meta):
self._meta = meta
@property
def meta(self):
return self._meta
def __getattr__(self, key):
fields = self._meta.get("fields_by_key", {})
if key in fields:
return fields[key]
raise AttributeError(f"'{type(self).__name__}' object has no attribute '{key}'")
def get(self, key):
return self._meta.get("fields_by_key", {}).get(key)
def set(self, key, value):
try:
variable = self._meta["fields_by_key"][key]
if hasattr(variable, "set"):
variable.set(value)
else:
self._meta["fields_by_key"][key] = value
except KeyError:
raise KeyError(f"Key '{key}' not found in DataBlockWrapper.")
def items(self):
return self._meta.get("fields_by_key", {}).items()
def values(self):
return self._meta.get("fields_by_key", {}).values()
def keys(self):
return self._meta.get("fields_by_key", {}).keys()
def __dir__(self):
return super().__dir__() + list(self._meta.get("fields_by_key", {}).keys())
Classes
DataBlockWrapper
class DataBlockWrapper(
meta
)
??? example "View Source" class DataBlockWrapper:
def __init__(self, meta):
self._meta = meta
@property
def meta(self):
return self._meta
def __getattr__(self, key):
fields = self._meta.get("fields_by_key", {})
if key in fields:
return fields[key]
raise AttributeError(f"'{type(self).__name__}' object has no attribute '{key}'")
def get(self, key):
return self._meta.get("fields_by_key", {}).get(key)
def set(self, key, value):
try:
variable = self._meta["fields_by_key"][key]
if hasattr(variable, "set"):
variable.set(value)
else:
self._meta["fields_by_key"][key] = value
except KeyError:
raise KeyError(f"Key '{key}' not found in DataBlockWrapper.")
def items(self):
return self._meta.get("fields_by_key", {}).items()
def values(self):
return self._meta.get("fields_by_key", {}).values()
def keys(self):
return self._meta.get("fields_by_key", {}).keys()
def __dir__(self):
return super().__dir__() + list(self._meta.get("fields_by_key", {}).keys())
Instance variables
meta
Methods
get
def get(
self,
key
)
??? example "View Source" def get(self, key):
return self._meta.get("fields_by_key", {}).get(key)
items
def items(
self
)
??? example "View Source" def items(self):
return self._meta.get("fields_by_key", {}).items()
keys
def keys(
self
)
??? example "View Source" def keys(self):
return self._meta.get("fields_by_key", {}).keys()
set
def set(
self,
key,
value
)
??? example "View Source" def set(self, key, value):
try:
variable = self._meta["fields_by_key"][key]
if hasattr(variable, "set"):
variable.set(value)
else:
self._meta["fields_by_key"][key] = value
except KeyError:
raise KeyError(f"Key '{key}' not found in DataBlockWrapper.")
values
def values(
self
)
??? example "View Source" def values(self):
return self._meta.get("fields_by_key", {}).values()
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file jabs_mimir-0.3.20.tar.gz.
File metadata
- Download URL: jabs_mimir-0.3.20.tar.gz
- Upload date:
- Size: 9.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.11.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
869c384f3b33b405ffd328a991322e5e83005aaab3924c77a5afa10df7983f12
|
|
| MD5 |
e558fa06b35b50fa5831e013685fe11c
|
|
| BLAKE2b-256 |
9209ceddfe485bfde28400fb54024ce8890a5929d2d661f1ebda0ca7c973f677
|
File details
Details for the file jabs_mimir-0.3.20-py3-none-any.whl.
File metadata
- Download URL: jabs_mimir-0.3.20-py3-none-any.whl
- Upload date:
- Size: 9.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.11.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
d8537f60ba416c02496258836fb3c30e0463bdc72ea457cadbb8ea41484c63ef
|
|
| MD5 |
43ac0ff51b984cdfe293bcd13d6f017d
|
|
| BLAKE2b-256 |
51ac4e06cc107e8fb5c9a8ab5af26030be4ede9a2a3390e85846e9698e57d66c
|