# LyricFlow IDE

LyricFlow is a Python/PyQt lyric-writing IDE with rhyme analysis powered by NLTK phonetics.

## Support Matrix

- Python: `3.14`
- Platforms: Windows and Linux (first-class)

## Install

```bash
cd lyricflow
python -m venv .venv
# Windows
.venv\Scripts\activate
# Linux/macOS
source .venv/bin/activate

python -m pip install --upgrade pip
python -m pip install -r requirements.txt
```

`requirements.txt` now includes shared root requirements via `../requirements-common.txt`.

## NLTK Data

LyricFlow uses `cmudict` and `wordnet`. For predictable startup behavior, the app does not auto-download missing corpora.
Install them once for full rhyme and synonym features:

```bash
python -m nltk.downloader cmudict wordnet
```

## Run

```bash
python run.py
```

## Tests

```bash
python -m unittest discover -s tests -p "test_*.py"
```