> For the complete documentation index, see [llms.txt](https://lebao3105.gitbook.io/texteditor_doc/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://lebao3105.gitbook.io/texteditor_doc/getting-started.md).

# 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:

<table data-full-width="false"><thead><tr><th width="182.66666666666666">GUI toolkit</th><th width="301">Hard to install?</th><th width="202">Interface</th></tr></thead><tbody><tr><td>wxPython</td><td>Yes for beginners (it will take you a very long time if there's no wheel for your OS)</td><td>Native OS look, but customizations are limited</td></tr><tr><td>Tkinter</td><td>No</td><td>Native OS look (on Linux it's ugly - Tk does not care about other toolkits like Qt).<br>Highly customizable.</td></tr></tbody></table>

{% content-ref url="/pages/NCACMdWgUjGIZNcd5RYO" %}
[textworker pre-1.6](/texteditor_doc/textworker-pre-1.6.md)
{% endcontent-ref %}

{% content-ref url="/pages/Qt2isOpL3ETT1Yk9ZOB4" %}
[textworker 1.6](/texteditor_doc/textworker-1.6.md)
{% endcontent-ref %}

See the full comparison [here](broken://spaces/12lvAEyy24K0tEPdOrK4/pages/RpZDCoQPk2y5pLYEHpMo).

## 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>.

{% hint style="warning" %}
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.
{% endhint %}

## Run

Quite easy - checkout the below:

```bash
$ # 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` :

```bash
$ textworker [args]
```

{% hint style="info" %}
If you choose to run the program from source (git repository), make sure to get all submodules by running `git submodule update --init --recursive`.
{% endhint %}

Using `--help` flag will show all available flags.

## Install

From source code:

```bash
python3 -m pip install .
```

From prebuilt `.whl` file:

```bash
python3 -m pip install <path_to_pip_file>.whl
```

From Pypi release:

```bash
python3 -m pip install textworker
```

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