Metadata-Version: 2.4
Name: desire-typer
Version: 0.1.0
Summary: Desire statement typing in your terminal.
Author: Mico Papp
License-Expression: MIT
Project-URL: Homepage, https://github.com/pmamico/desire-typer
Project-URL: Repository, https://github.com/pmamico/desire-typer
Project-URL: Issues, https://github.com/pmamico/desire-typer/issues
Keywords: typing,typing-test,typing-speed,typing-practice,wpm,terminal,cli,monkeytype,speed-typing,keyboard,curses,typing-game,touch-typing,desire,statements
Classifier: Environment :: Console :: Curses
Classifier: Topic :: Games/Entertainment
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: MacOS
Classifier: Operating System :: POSIX :: Linux
Classifier: Operating System :: Microsoft :: Windows
Classifier: Intended Audience :: End Users/Desktop
Classifier: Intended Audience :: Developers
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: windows-curses>=2.3; sys_platform == "win32"
Dynamic: license-file

# Desire Statement Typer

Desire statement typing in your terminal.

You maintain a folder of desire statements under `~/.statements/`. The app picks one at random and you type it out.

## Inspiration

This project is inspired by the “Desire Statement” mental training tool from Kenneth Baum’s *The Mental Edge* (1999): a short, specific statement of what you truly want, revisited often to keep motivation and focus high. Reference: [The Mental Edge (Heroic summary)](https://legacy.heroic.us/pn/the-mental-edge-kenneth-baum#hows-your-desire)

## Install

Local install (until the package is published on PyPI):

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

`pipx` also works well for CLI tools:

```bash
pipx install .
```

PyPI install (after publishing; it installs the `desire` CLI):

```bash
python3 -m pip install --upgrade desire-typer
```

Homebrew is not supported yet.

## Run

```bash
desire
```

Or, if you prefer module execution:

```bash
python -m desire
```

## Statements Folder

- Location: `~/.statements/`
- One statement per non-empty line
- Multi-line statements: end the line with a trailing `\` to continue on the next line
- Lines starting with `#` are ignored

Example `~/.statements/my_statements.txt`:

```text
# one-liners
I treat my time with respect.
I finish what I start.

# multi-line (note the trailing backslash)
I am the kind of person who \
does the work even when I do not feel like it.
```

## Controls

| Key   | Action |
|------:|--------|
| `tab` | new statement |
| `esc` | quit |
| `s`   | stats |
| `t`   | cycle theme |

## Data Storage

- Statements: `~/.statements/`
- Local profile/stats: `~/.config/typer/profile.json` (legacy path name)

## Update

```bash
python3 -m pip install --upgrade desire-typer
```

## Platform Notes

- macOS/Linux: uses stdlib `curses`
- Windows: requires `windows-curses` (declared as a conditional dependency in `pyproject.toml`)
