Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/anze3db/words-tui

A TUI (Text User Interface) app for daily writing.
https://github.com/anze3db/words-tui

daily python textual tui writing

Last synced: 2 months ago
JSON representation

A TUI (Text User Interface) app for daily writing.

Host: GitHub
URL: https://github.com/anze3db/words-tui
Owner: anze3db
License: mit
Created: 2023-07-31T18:50:43.000Z (over 1 year ago)
Default Branch: main
Last Pushed: 2023-12-04T12:09:43.000Z (about 1 year ago)
Last Synced: 2024-10-10T20:57:33.450Z (3 months ago)
Topics: daily, python, textual, tui, writing
Language: Python
Homepage:
Size: 112 KB
Stars: 43
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

        
![Screenshot 2023-08-24 at 08 13 47](https://github.com/anze3db/words-tui/assets/513444/021d5cd8-da5d-43b6-8747-ff1c1cb31d6e)

# words-tui

`words-tui` is an app for daily writing in your terminal, built with [Textual](https://github.com/Textualize/textual).

[![PyPI - Version](https://img.shields.io/pypi/v/words-tui.svg)](https://pypi.org/project/words-tui)

[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/words-tui.svg)](https://pypi.org/project/words-tui)

[![Build and Test](https://github.com/anze3db/words-tui/actions/workflows/build-and-test.yml/badge.svg)](https://github.com/anze3db/words-tui/actions/workflows/build-and-test.yml)

-----

**Table of Contents**

- [Demo](#demo)

- [Installation](#installation)

- [Running](#running)

- [License](#license)

## 🎬 Demo

https://github.com/anze3db/words-tui/assets/513444/5f064606-384f-471d-8990-f4681dfff29c

## Installation

The easiest way to install `words-tui` is with [pipx](https://pypa.github.io/pipx/).

```console

pipx install words-tui

```

Alternatively, you can install it with `pip`:

```console

pip install words-tui

```

## Running

To run `words-tui`, simply run the following command:

```console

words-tui

```

It stores all of your writing in ~/.words-tui.db by default, but you can override this with the `WORDS_TUI_DB` environment variable or the `--db` flag.

```console

words-tui --db /path/to/db

```

## License

`words-tui` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.