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.2.tar.gz (3.1 kB view details)

Uploaded Source

Built Distribution

pun_cli-0.1.2-py3-none-any.whl (3.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: pun_cli-0.1.2.tar.gz
  • Upload date:
  • Size: 3.1 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.2.tar.gz
Algorithm Hash digest
SHA256 e8fe5a1282674fc3dd122567222419463c51f11f42d434c36ba5e3b8a03d4791
MD5 00dc20dea9b0f7238ecf031d669514da
BLAKE2b-256 3a15e2b7fdccf31f121c2e236333f0fbecf0d90369171ec11d4b386920b8f19b

See more details on using hashes here.

File details

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

File metadata

  • Download URL: pun_cli-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 3.7 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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 a2a6ae83b31d01dffad0e645e12688ddc060b3626c146131e6870ba33d39b16c
MD5 0cbe14ee533eff53901492d1cf2da3a1
BLAKE2b-256 dbf6b1ceb1c546b3ff1ee819b17a49608f68f0431bb169bdc052e04af19928cd

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