Metadata-Version: 2.4
Name: lyricsipsum
Version: 1.1.3
Summary: Generates Lorem Ipsum text using song lyrics
License-Expression: MIT
License-File: LICENSE
Keywords: lorem,ipsum,text,generator,lyrics,utility,command-line,cli
Author: Steve Scholnick
Author-email: scholnicks@gmail.com
Requires-Python: >=3.14
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3.14
Classifier: License :: OSI Approved :: MIT License
Classifier: Topic :: Utilities
Requires-Dist: docopt-ng (>=0.9.0,<0.10.0)
Requires-Dist: lyricsgenius (>=3.7.2,<4.0.0)
Project-URL: Homepage, https://pypi.org/project/lyricsipsum/
Project-URL: Repository, https://github.com/scholnicks/lyricsipsum/
Project-URL: issues, https://github.com/scholnicks/lyricsipsum/issues
Description-Content-Type: text/markdown

# lyricsipsum

lyricsipsum randomly selects a downloaded song's lyrics as a replacement for standard boring lorem ipsum text.

```
Usage:
    lyricsipsum [options]

Options:
    -d, --debug         Enable debug mode
    -h, --help          Show this help screen
    -n, --number=<num>  Number of songs to download [default: 50]
    -s, --save          Save lyrics to file
    -t, --title         Print the song title along with the lyrics
    --version           Prints the version
```

## Installation

```bash
pip install lyricsipsum
```

### Create Configuration Directory
```bash
mkdir -p ~/.config/lyricsipsum
```

### Create configuration file
```bash
cat <<EOF > ~/.config/lyricsipsum.config.toml
[client]
verbose=true
skip_non_song=true
excluded_terms=["(Remix)", "(Live)"]
remove_section_headers=true
timeout=15
EOF
```

### Setup Genuis API Access
Following Authorization instructions on https://lyricsgenius.readthedocs.io/en/master/setup.html

## License

lyricsipsum is freeware released under the [MIT License](https://github.com/scholnicks/lyricsipsum/blob/main/LICENSE).

