Skip to main content

Pun-CLI: Because you can't resist a good pun. Generate hilarious puns from our pun repository or contribute your own puns to the list. Pun-CLI, the command-line tool you never knew you needed.

Project description

Pun CLI

pun-cli is a Python-based command-line tool that generates a random pun based on a given keyword.

Installation

You can install pun-cli via pip:

pip install pun-cli

Usage

pun-cli [-h] [--keyword KEYWORD] [--version] [--add]

Optional Arguments

  --keyword (-k): A keyword to search for puns. By default, pun-cli generates a random pun.
  --version (-v): Show the version number and exit.
  --add (-a): Add a pun to the repository.

Examples

$ pun-cli
Why was the math book sad? Because it had too many problems.

$ pun-cli -k cheese
I’m reading a book about anti-gravity. It’s impossible to put down.

Adding a Pun

To add a pun to the repository, follow these steps:

  1. Fork the pun-cli repository.
  2. Clone your fork to your local machine.
  3. Add your pun to pun_repository.txt file.
  4. Commit your changes and push to your fork.
  5. Create a pull request to merge your changes into the main pun-cli repository.

Contributing

If you'd like to contribute to pun-cli, please open an issue or a pull request on the GitHub repository.

License

pun-cli is licensed under the MIT License.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pun_cli-0.1.4.tar.gz (3.3 kB view details)

Uploaded Source

Built Distribution

pun_cli-0.1.4-py3-none-any.whl (4.4 kB view details)

Uploaded Python 3

File details

Details for the file pun_cli-0.1.4.tar.gz.

File metadata

  • Download URL: pun_cli-0.1.4.tar.gz
  • Upload date:
  • Size: 3.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.4.1 CPython/3.10.7 Linux/5.19.0-38-generic

File hashes

Hashes for pun_cli-0.1.4.tar.gz
Algorithm Hash digest
SHA256 6cba36504c873d539399bbe1be7577dcbbd84b8c4d71ed4163ae8a31cb1da785
MD5 81bcfa48d50b456dd7cf7bdca29686a9
BLAKE2b-256 f47ef381682d78db2588fe82e45cde20c71448b75fcfdaa223d46ecd314be6ed

See more details on using hashes here.

File details

Details for the file pun_cli-0.1.4-py3-none-any.whl.

File metadata

  • Download URL: pun_cli-0.1.4-py3-none-any.whl
  • Upload date:
  • Size: 4.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.4.1 CPython/3.10.7 Linux/5.19.0-38-generic

File hashes

Hashes for pun_cli-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 c0c62bbe2777dfd8ad649bd92ec3520cdfbcdfab433e5f97a4990f593dc0cc98
MD5 eff496e961e17fa1421885c58873ebd0
BLAKE2b-256 aca6fbc7c6e58c5138000fe1af66170d7d8e9e54eecdab58f09069018f9cad32

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page