Getting Started

Installation

To get a local copy up and running choose one of the below install instructions and follow the steps provided.

Install With PIP

The simplest way to install tkintermd is to use pip:

pip install tkintermd

Install From Source

Alternatively you can install from source by following the steps below:

1. Clone the repo:

git clone https://github.com/hreikin/tkintermd.git
cd tkintermd/

1. Create and source a Python virtual environment:

python3 -m venv .venv
source .venv/bin/activate

1. Install requirements with pip:

pip install -r requirements.txt

Usage

Embedded

To use the TkintermdFrame in one of your own python scripts:

from tkintermd.frame import TkintermdFrame

import tkinter as tk
from tkinter.constants import *

root = tk.Tk()
app = TkintermdFrame(root)
app.pack(fill="both", expand=1)
app.mainloop()

---

Last update: 2023-09-26