A lightweight Python toolkit for fetching and generating jokes, dad jokes, and roasts.
Project description
FunKitPy
A lightweight Python library and CLI for jokes, dad jokes, and roasts.
Features
- 🎭 Random jokes
- 👨 Dad jokes
- 🔥 Roasts
- 💻 Command Line Interface (CLI)
- 📦 Zero dependencies
- ⚡ Fast & lightweight
- 🐍 Python 3.8+
Installation
pip install FunKitPy
Quick Start
from funkitpy import joke, dad_joke, roast
print(joke())
print(dad_joke())
print(roast())
Python API
Random Joke
from funkitpy import joke
print(joke())
Dad Joke
from funkitpy import dad_joke
print(dad_joke())
Roast
from funkitpy import roast
print(roast())
Compatibility Aliases
The following aliases are also available:
from funkitpy import get_joke
from funkitpy import get_dad_joke
from funkitpy import get_roast
These functions behave exactly the same as:
joke()
dad_joke()
roast()
Command Line Interface
FunKitPy includes a built-in CLI.
Random Joke
funkit joke
Dad Joke
funkit dad-joke
Roast
funkit roast
Show Version
funkit -v
funkit -V
funkit --version
Show Commands
funkit commands
Example Output
Why don't scientists trust atoms?
Because they make up everything.
Project Structure
funkitpy/
├── funkitpy/
│ ├── __init__.py
│ ├── jokes.py
│ ├── roasts.py
│ ├── cli.py
│ ├── version.py
│ └── data/
│ ├── jokes.json
│ ├── dad_jokes.json
│ └── roasts.json
├── tests/
├── pyproject.toml
├── LICENSE
└── README.md
Contributing
Contributions, bug reports, and feature requests are welcome.
- Fork the repository
- Create a branch
- Make your changes
- Submit a pull request
Links
Homepage: https://github.com/fmasterpro27/FunKitPy
Issues: https://github.com/fmasterpro27/FunKitPy/issues
PyPI: https://pypi.org/project/funkitpy/
License
Licensed under the Apache License 2.0.
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
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 funkitpy-0.2.1.tar.gz.
File metadata
- Download URL: funkitpy-0.2.1.tar.gz
- Upload date:
- Size: 19.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.13.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
6986ad362d6608aa941df9b5c1bea3c2b3e77b0ec731c6eb570f03a74e801361
|
|
| MD5 |
170d43aeb20593bedfec90194d64d521
|
|
| BLAKE2b-256 |
0c2dcf00b8f949a38897de87a642a2122cbde39b7e956b979f2dd2387170e639
|
File details
Details for the file funkitpy-0.2.1-py3-none-any.whl.
File metadata
- Download URL: funkitpy-0.2.1-py3-none-any.whl
- Upload date:
- Size: 20.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.13.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
ad3fca9febb85ee91a163dac166d2331423c2796a58eb9608f30681ab57bec47
|
|
| MD5 |
b00ec98783f3cc7bb222321bc8df5381
|
|
| BLAKE2b-256 |
b1c577c2757628d0d2a0f335059ef74f79017e267f0db777725b0ef93b0fdd3a
|