Getting started

Choose what you want

texteditor/textworker comes with 2 different versions with 2 different UI toolkit. Below is where to get them:

• Tkinter: The first UI toolkit used. The project's current version is 1.4.1, available as the texteditor package on TestPypi (not to confuse with the one on Pypi!). Customized to have Microsoft WinUI 3-like interface.

• wxPython: The toolkit used in version 1.6. Installable via Pypi as the textworker package.

Both 2 GUIs are different:

GUI toolkit	Hard to install?	Interface
wxPython	Yes for beginners (it will take you a very long time if there's no wheel for your OS)	Native OS look, but customizations are limited
Tkinter	No	Native OS look (on Linux it's ugly - Tk does not care about other toolkits like Qt). Highly customizable.

textworker pre-1.6textworker 1.6

See the full comparison here.

Where to get

This page: https://gitlab.com/textworker/legacy-python/textworker/releases.

For Tkinter version: https://gitlab.com/textworker/legacy-python/textworker-tkinter/releases

This project is available on https://pypi.org/project/textworker.

For Tkinter version: https://test.pypi.org/project/texteditor.

Releases that has libtextworker as their dependency requires the library to be installed manually. To resolve this problem, use Git to switch to the published version's Git tag, get and install libtextworker from there, or look for the specified git commit on GitHub releases.

Run

Quite easy - checkout the below:

$ # Normally we just need this
$ python3 -m textworker [file]
$ # Or more:
$ python3 -m textworker [file] [extra args]

For the installed versions that are placed on $PATH, you will be able to run the program without python3 -m :

$ textworker [args]

If you choose to run the program from source (git repository), make sure to get all submodules by running git submodule update --init --recursive.

Using --help flag will show all available flags.

Install

From source code:

python3 -m pip install .

From prebuilt .whl file:

python3 -m pip install <path_to_pip_file>.whl

From Pypi release:

python3 -m pip install textworker

Pip supports many more ways to install projects, read its documentation for that.