Metadata-Version: 2.4
Name: cowspam
Version: 1.0.0
Summary: A small, silly, screen-cluttering library derived from Cowsay Python.
Author-email: Ian Rodriguez <rodriguezian403@gmail.com>
License-Expression: MIT
Requires-Python: >=3.12
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: cowsay
Requires-Dist: faker
Dynamic: license-file

# cowspam
A small, silly, screen-cluttering Python library derived from [Cowsay](https://pypi.org/project/cowsay/). By Ian Rodriguez.

Cowsay was originally created by Tony Monroe, and its Python port by multiple contributors is available as a [GitHub repo](https://github.com/VaasuDevanS/cowsay-python). The purpose of **cowspam** is a personal challenge to see how far I can go with making a derivative of such a small, niche library.

Requires pip and Python 3.12 or later. From the project directory, build with these commands:

    python -m pip install .
    cowspam --help

Or build a distributable package:

    python -m pip install build
    python -m build

## Library

```python
from cowspam import Cow, make_cow_text, run_kilobytes

cow = Cow("Bessie")
cow.moo()

text, is_normal = make_cow_text()
counts, bytes_generated = run_kilobytes(1, write_output=False) # Generates 1 KB of cowsay spam
```

## CLI Commands
- `-h / --help` - View commands
- `(loops)` - Positional argument; enter a number of cows to generate, either to terminal or piped to a file. Default: 100.
- `-a / --auto` - Run without a 1-second delay between cowsay prints; automatic for piped
- `-f / --flash` - (Epilepsy warning) Clear the screen for each cow print, creating a flashing effect
- `-k / --kb / --kilobytes X` - Alternative to loops: generate cowsay prints until X amount is generated in kilobytes.
- `-n / --normal` - Only generate normal cows
