Skip to content

Fmasterpro27/FunKitPy

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

15 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

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.

About

A lightweight Python toolkit for fetching and generating jokes, dad jokes, and roasts.

Topics

Resources

License

Security policy

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages