Skip to content

Fmasterpro27/FunKitPy

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

FunKitPy

A lightweight Python library and CLI for jokes, dad jokes, and roasts.

PyPI version Python versions License


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.

  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.

About

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

Topics

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages