Metadata-Version: 2.4
Name: triumphant
Version: 0.1.1
Summary: A most excellent Bill and Ted quote machine. Party on, dudes!
Author: bspreston-esq
License-Expression: GPL-3.0-only
Project-URL: Homepage, https://github.com/bspreston-esq/triumphant
Project-URL: Repository, https://github.com/bspreston-esq/triumphant
Project-URL: Issues, https://github.com/bspreston-esq/triumphant/issues
Keywords: bill-and-ted,quotes,excellent,triumphant
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Classifier: Natural Language :: English
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Dynamic: license-file

# triumphant

Whoa! This is the most excellent little program in the whole Western
Civilization. Fire up `triumphant.py` and it doles out a righteous quote from
the dudes themselves — Bill and Ted, no less!

## Party on, man: usage

Grab a bodacious quote, dude:

    python triumphant.py

Strange things are afoot at the Circle-K? Play it safe, dudes:

    python triumphant.py --careful

Things went totally heinous? Express yourself:

    python triumphant.py --bogus

Need a hand, man? The program's got your back:

    python triumphant.py --help

And if you toss it some bogus, non-triumphant argument, it'll school you with
a usage message. Most impressive.

## Excellent quality, dude

Be excellent to each other:

- Random quote from the righteous set when you run it plain.
- `--careful` picks from the cautious set.
- `--bogus` picks from the most non-triumphant set.
- `--help` shows the usage, and invalid flags get the boot (exit code and
  all, man).

## Party on from PyPI, dude

Whoa, the whole quote machine is on PyPI now as **`triumphant`** — most
triumphant, dudes:

    pip install triumphant

Then call up a righteous quote from anywhere, dude:

    triumphant             # a righteous quote
    triumphant --careful   # strange things are afoot at the Circle-K
    triumphant --bogus     # things are most heinously failing

## Development, dudes

The main branch is a most protected zone — no direct commits, no way, man.
All changes roll in via pull requests, and CI (see `.github/workflows/ci.yml`)
has got to come up most triumphant before anything merges into main.

Want to contribute? Party on, but be excellent to each other — and write any
README updates in this same Bill and Ted style. Most outstanding!

## License

See [LICENSE](LICENSE).
