Skip to main content

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, roasts, and inspirational quotes.

PyPI version Python versions License


Features

  • ๐ŸŽญ Random jokes
  • ๐Ÿ‘จ Dad jokes
  • ๐Ÿ”ฅ Roasts
  • ๐Ÿ’ฌ Inspirational quotes
  • ๐Ÿ“š Includes 5,421+ quotes
  • ๐Ÿ’ป Command Line Interface (CLI)
  • ๐Ÿ“ฆ Zero dependencies
  • โšก Fast & lightweight
  • ๐Ÿ Python 3.8+

Installation

pip install FunKitPy

Quick Start

from funkitpy import joke, dad_joke, roast, quote

print(joke())
print(dad_joke())
print(roast())
print(quote())

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())

Quote

from funkitpy import quote

print(quote())

Quote Data

Returns the raw quote dictionary.

from funkitpy import quote_data

print(quote_data())

Example:

{
    "quote": "The best way to get started is to quit talking and begin doing.",
    "author": "Walt Disney"
}

Compatibility Aliases

The following aliases are also available:

from funkitpy import (
    get_joke,
    get_dad_joke,
    get_roast,
    get_quote
)

These functions behave exactly the same as:

joke()
dad_joke()
roast()
quote()

Command Line Interface

FunKitPy includes a built-in CLI.

Random Joke

funkit joke

Dad Joke

funkit dad-joke

Roast

funkit roast

Quote

funkit quote

Show Version

funkit -v
funkit -V
funkit --version

Show Commands

funkit commands

Output:

joke
dad-joke
roast
quote

Example Output

Joke

Why don't scientists trust atoms?
Because they make up everything.

Quote

"The best way to get started is to quit talking and begin doing."

โ€” Walt Disney

Project Structure

funkitpy/
โ”œโ”€โ”€ funkitpy/
โ”‚   โ”œโ”€โ”€ __init__.py
โ”‚   โ”œโ”€โ”€ jokes.py
โ”‚   โ”œโ”€โ”€ roasts.py
โ”‚   โ”œโ”€โ”€ quotes.py
โ”‚   โ”œโ”€โ”€ cli.py
โ”‚   โ”œโ”€โ”€ version.py
โ”‚   โ””โ”€โ”€ data/
โ”‚       โ”œโ”€โ”€ jokes.json
โ”‚       โ”œโ”€โ”€ dad_jokes.json
โ”‚       โ”œโ”€โ”€ roasts.json
โ”‚       โ””โ”€โ”€ quotes.json
โ”œโ”€โ”€ tests/
โ”œโ”€โ”€ pyproject.toml
โ”œโ”€โ”€ LICENSE
โ””โ”€โ”€ README.md

Why FunKitPy?

  • No API keys required
  • No internet connection required
  • Lightweight and fast
  • Easy Python API
  • Simple CLI
  • Great for bots, scripts, terminals, and fun projects
  • Includes a collection of 5,421+ inspirational quotes

Contributing

Contributions, bug reports, and feature requests are welcome.

  1. Fork the repository
  2. Create a branch
  3. Make your changes
  4. 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

funkitpy-0.3.0.tar.gz (222.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

funkitpy-0.3.0-py3-none-any.whl (227.1 kB view details)

Uploaded Python 3

File details

Details for the file funkitpy-0.3.0.tar.gz.

File metadata

  • Download URL: funkitpy-0.3.0.tar.gz
  • Upload date:
  • Size: 222.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.13

File hashes

Hashes for funkitpy-0.3.0.tar.gz
Algorithm Hash digest
SHA256 a1b3706cce21ba848b9efa43598d5ca44113ece3d44ab5474178d555be27863d
MD5 c1129d99f454229bd1349ccebfb14e7a
BLAKE2b-256 9de528e7089030e05bf20314cc9c49eb0c746a9b87389885bda4c4d51196e2e2

See more details on using hashes here.

File details

Details for the file funkitpy-0.3.0-py3-none-any.whl.

File metadata

  • Download URL: funkitpy-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 227.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.13

File hashes

Hashes for funkitpy-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f4114eccb65944ebec4ff95ce4452c99549c0e3dc3c0dcf3ffae4e3ce4fe948c
MD5 b9b5c67e6cbc2ced7ca3059ddad1303b
BLAKE2b-256 b9eb86b1868b1cd6ccf10d70ae8e302c3335bb96e2a623405f61d6470d83f133

See more details on using hashes here.

Supported by

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