Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

PyPI PyPI - Python Version Platform

TkTerm - Tkinter Terminal Emulator

A fully functional terminal emulator built on Tkinter library - perform all basic commands of a terminal

Under the hood it executes commands using Python's subprocess module and spawn as a thread. Pressing Ctrl-C will terminate current running command. Supports Unix shells (sh and bash) and Window's Command Prompt (cmd.exe) commands.

Features

  • Compatible with Windows and Unix systems
  • Tabbed Terminal - click & drag to reorder, middle-click to close tab, double-click to rename
  • Return Code (RC) of previous run commands is shown at the bottom status bar
  • Settings to customise colours, font and cursor shape
  • Ctrl-C to kill current running process
  • Ctrl-F to search; supports case sensitivity and regex searches
  • UP and DOWN arrow keys to cycle between next and previous commands in history
  • Unix-like tab completion on files and directories
  • Handles multiline commands using caret character ^ or \

Requirements

The Tkinter GUI library is built into Python, so no 3rd party library is required.

Requires at least Python version 3.x and above.

Installation

Get it from Github or PIP package manager

# From github
git clone https://github.com/dhanoosu/TkTerm.git

# From package manager
pip install tkterm

Standalone usage

Navigate to downloaded folder and run script with

cd TkTerm

# Either of these will work
python tkterm
python tkterm/tkterm.py

If package was installed via pip

python -m tkterm

Integration with other Tkinter application

The Terminal is implemented as a Frame widget and can easily be integrated to other Tkinter application by

import tkinter as tk
from tkinter import *
from tkterm import Terminal

root = tk.Tk()

terminal = Terminal(root)
terminal.pack(fill=BOTH, expand=True)

root.mainloop()

If downloaded via github append to system path before import

import sys
sys.path.insert(0, "./TkTerm")
from tkterm import Terminal

Customisation options

Customise Terminal interface by Right-click > Settings...

Note:
Clicking Save config saves setting configuration to a file.
Tkterm will automatically load this file the next time it starts up.

Multiline command

Long lines of command can be broken up using a caret. A caret at the line end appends the next line command with the current command. In Windows the caret is ^, and UNIX is \.

For multiline command to be considered there must be no trailing space after the caret, for example:

  • $> ping ^ is considered
  • $> ping ^ is not considered
$>> echo I ^
> have apple ^
> and banana
I have apple and banana

Author

Developed by Dhanoo Surasarang

Github: @dhanoosu

Release files for tkterm 0.0.0b2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for tkterm 0.0.0b2
File Size Uploaded
tkterm-0.0.0b2.tar.gz 139.2 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for tkterm 0.0.0b2
File Interpreter ABI Platform
tkterm-0.0.0b2-py3-none-any.whl Python 3 none any Details

Total release size: 285.8 kB

Release files / tkterm-0.0.0b2.tar.gz

Download URL tkterm-0.0.0b2.tar.gz
Size 139.2 kB
Tags Source
SHA-256 checksum
How to use checksums
52369039dfd5cbd1b0044a8593be19028f9123ea003bbd5d69aa1fb38e4e37fe
BLAKE2b-256 checksum
How to use checksums
1541fe3224472f9bff1fb1d360e9ff656792b7e508d1850ff4b6321f8c78da47
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.11.3

Release files / tkterm-0.0.0b2-py3-none-any.whl

Download URL tkterm-0.0.0b2-py3-none-any.whl
Size 146.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
7ceafad182b49de408303e8b594b4ac867627eb4944f3494dff8c60a59a1ff4e
BLAKE2b-256 checksum
How to use checksums
03436cf82c3830a94e9a66e141ef0a7658f3f95af10d1f481b5323cd567b9213
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.11.3

Release history Release notifications | RSS feed

This release

0.0.0b2 This release

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page