A lighthearted Python package that brings joy.
Project description
Python Package Exercise
ChucklePy - A Fun Python Package
What is ChucklePy?
ChucklePy is a fun Python package designed to bring humor to developers’ lives.
With puns, comedic insults, text amusement, and random fortunes, it keeps coding entertaining.
Installation
Install ChucklePy directly from PyPI:
pip install chucklepy
Import the package in your code:
from chucklepy import generate_pun, comedic_insult, amuseify_text, random_fortune
Usage Examples
Here’s how you can use ChucklePy in your Python scripts:
- Generate a Pun
pun = generate_pun(category="tech", length="short")
print(pun)
“A SQL query walks into a bar, sees two tables, and asks: 'Can I join you?'”
- Generate a Comedic Insult
insult = comedic_insult("Alice", severity=2)
print(insult)
“Alice, your code is like a maze — I've gone in circles three times and I'm still nowhere near an exit!”
- Amuseify Text
fun_text = amuseify_text("Hello world!", style="emoji")
print(fun_text)
“Hello👾 world!”
- Get a Random Fortune
from chucklepy import random_fortune
fortune = random_fortune(topic="career", mood="sarcastic")
print(fortune)
“Not writing bugs tonight only means writing double the bugs tomorrow.”
See more examples in the example program.
PyPI package link
Contributing to ChucklePy
We love contributions! Here’s how you can set up the project locally:
Clone the Repository
git clone https://github.com/software-students-spring2025/3-python-package-httprequest.git
Set Up Virtual Environment
- Using Pipenv:
pipenv install --dev
pipenv shell
- Run Tests
pipenv run pytest
cd src
pytest tests
- Build and Install the Package Locally
pipenv run python -m build
pip install dist/chucklepy-*.whl
Team Members
Running the Project on Any Platform
- Ensure Python 3.9+ is installed
- Clone the repository
- Install dependencies
- Run tests
- Execute the example script
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file chucklepy-0.1.1.tar.gz.
File metadata
- Download URL: chucklepy-0.1.1.tar.gz
- Upload date:
- Size: 19.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.13.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
f5acd72c14e1385ddfb7f6fa75f61c4ef08c5b3be8bdd9865774f15a5c63b182
|
|
| MD5 |
769d0e7a785f7244124a0e9786030eac
|
|
| BLAKE2b-256 |
5cc189298e613b0eb869fd4d7436a9b67af32e968bbb9706f32ee2e141401219
|
File details
Details for the file chucklepy-0.1.1-py3-none-any.whl.
File metadata
- Download URL: chucklepy-0.1.1-py3-none-any.whl
- Upload date:
- Size: 19.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.13.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
19f31fb63fe0a4067d679aaccc0cc612155bcc452c7f2886b90fdc382786ce2a
|
|
| MD5 |
5405341fb1382caf799103040efe5161
|
|
| BLAKE2b-256 |
6447bb5b3839a434f0de6b9a749cff6b57b435313bca2ecc46d82c46f1576f30
|