pyLyricFlow/README.md
2026-02-24 13:22:10 -06:00

851 B

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

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:

python -m nltk.downloader cmudict wordnet

Run

python run.py

Tests

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