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,521+ 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, advice

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

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

Advice

from funkitpy import advice

print(advice())

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,
    get_advice
)

These functions behave exactly the same as:

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

Command Line Interface

FunKitPy includes a built-in CLI.

Random Joke

funkit joke

Dad Joke

funkit dad-joke

Roast

funkit roast

Quote

funkit quote

Advice

funkit advice

Show Version

funkit -v
funkit -V
funkit --version

Show Commands

funkit commands

Output:

joke
dad-joke
roast
quote
advice

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
โ”‚   โ”œโ”€โ”€ advices.py
โ”‚   โ”œโ”€โ”€ jokes.py
โ”‚   โ”œโ”€โ”€ roasts.py
โ”‚   โ”œโ”€โ”€ quotes.py
โ”‚   โ”œโ”€โ”€ cli.py
โ”‚   โ”œโ”€โ”€ version.py
โ”‚   โ””โ”€โ”€ data/
โ”‚       โ”œโ”€โ”€ advices.json
โ”‚       โ”œโ”€โ”€ 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

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.4.0.tar.gz (225.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.4.0-py3-none-any.whl (230.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: funkitpy-0.4.0.tar.gz
  • Upload date:
  • Size: 225.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.4.0.tar.gz
Algorithm Hash digest
SHA256 d8af190365b995b6af97cfcf994c622373a6f1a8d65916e9fbc8ae7916b3482c
MD5 17d66b3536394b94c1292ccf74db2ac7
BLAKE2b-256 18af77f56afe89414eb8eb43269b5cbd36e8ea5dda22bb7cd2a960ecadb04e1d

See more details on using hashes here.

File details

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

File metadata

  • Download URL: funkitpy-0.4.0-py3-none-any.whl
  • Upload date:
  • Size: 230.6 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.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9de7eae6c634eaa91b747b04e8d768948188c4855bd50af7f2792e9b9497afa9
MD5 1b87f6cfbf6ef8739fed41d80af55d82
BLAKE2b-256 4f0385ebd2a59385c6be7bf5fa8713ee85eea9b0ef196c4dd32490647a33874c

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