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

Uploaded Source

Built Distribution

pun_cli-0.1.3-py3-none-any.whl (4.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: pun_cli-0.1.3.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.3.tar.gz
Algorithm Hash digest
SHA256 a8bb9bca8007a29bea8387ba621c6bb36e19ade798386fd417f44aa43b02a536
MD5 ce25bc0c50a0b186036d58fcbe32e6a0
BLAKE2b-256 3be24c265eba4735b65d869092b414fbb18e58ed91cde8c16c6adaa388f71eb3

See more details on using hashes here.

File details

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

File metadata

  • Download URL: pun_cli-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 4.1 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.3-py3-none-any.whl
Algorithm Hash digest
SHA256 9841ec0477f73da63b787ba4effc7654278daa5ccb0db55d2b3fe9068df4c5c0
MD5 384f8cd58334abee831bf67ab6fbe262
BLAKE2b-256 d6ef65fb4683f04d438488fdb4180e24bef292f22499066f072b40a36ba2ddbd

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