Command line#

Installing ttkbootstrap installs a command, ttkb, for the things that are not library calls: reporting the version, opening the demo, converting a 1.x theme, and launching the theme designer.

ttkb version
ttkb demo
ttkb convert-theme user.py -o brand.py
ttkb creator

Run ttkb with no arguments, or ttkb <command> --help, for usage.

Note

The command installs under two names — ttkb and ttkbootstrap — that run the same thing.

When your environment’s scripts directory is not on PATH, run the same commands as python -m ttkbootstrap.cli <command>. The demo, converter and theme designer each also keep the individual python -m spelling they had before, listed below.

Commands#

Command	What it does
`ttkb version`	Print the installed version, e.g. `2.2.0`. Same value as `ttkbootstrap.__version__`.
`ttkb demo`	Open the widget demo: every themed widget on one window, with a theme picker. Same as `python -m ttkbootstrap`.
`ttkb convert-theme`	Convert a ttkbootstrap 1.x theme file into the 2.x `Theme(...).register()` form. Same as `python -m ttkbootstrap.convert_theme`.
`ttkb creator`	Open ttkcreator, the theme designer. Same as `python -m ttkcreator`.

version#

$ ttkb version
2.2.0

Prints the version of the installed distribution — the same string as ttkbootstrap.__version__, and what to quote in a bug report.

import ttkbootstrap as ttk

print(ttk.__version__)

demo#

ttkb demo

Opens a window showing the widget set under the current theme, with a picker that switches themes live. It is a good first check that your install works and a quick way to see what a theme looks like before choosing one.

convert-theme#

ttkb convert-theme <file> [-o <output>]

Reads a theme file saved by ttkbootstrap 1.x and writes the equivalent 2.x Theme(...).register() call. All three artifacts 1.x could produce are accepted:

File	Where it came from
`user.py` (a `USER_THEMES` dict)	ttkcreator’s Save and Export all themes
`.py` (a `ThemeDefinition(...)` call)	ttkcreator’s Export theme definition
`.json`	the `load_user_themes()` format

Every theme in the file converts. Output goes to standard output, or to the file named by -o.

$ ttkb convert-theme user.py -o brand.py
Wrote brand.py

Import the generated module and the themes are available by name:

import ttkbootstrap as ttk
import brand  # registers the converted themes

app = ttk.App(theme="acme-light")

See Migrating to 2.0 for what carries over and what 2.x derives instead.

creator#

ttkb creator

Opens ttkcreator: edit a theme’s accent, neutral, and background colors, preview the result on live widgets, and export a Theme(...).register() snippet to drop into your own app.