Release v0.3.0

Author: Fmasterpro27

README.md

@@ -1,6 +1,6 @@
 # FunKitPy
 
-> A lightweight Python library and CLI for jokes, dad jokes, and roasts.
+> A lightweight Python library and CLI for jokes, dad jokes, roasts, and inspirational quotes.
 
 [![PyPI version](https://img.shields.io/pypi/v/funkitpy.svg)](https://pypi.org/project/funkitpy/)
 [![Python versions](https://img.shields.io/pypi/pyversions/funkitpy.svg)](https://pypi.org/project/funkitpy/)
@@ -13,6 +13,8 @@
 - 🎭 Random jokes
 - 👨 Dad jokes
 - 🔥 Roasts
+- 💬 Inspirational quotes
+- 📚 Includes **5,421+ quotes**
 - 💻 Command Line Interface (CLI)
 - 📦 Zero dependencies
 - ⚡ Fast & lightweight
@@ -31,11 +33,12 @@ pip install FunKitPy
 ## Quick Start
 
 ```python
-from funkitpy import joke, dad_joke, roast
+from funkitpy import joke, dad_joke, roast, quote
 
 print(joke())
 print(dad_joke())
 print(roast())
+print(quote())
 ```
 
 ---
@@ -66,16 +69,46 @@ from funkitpy import roast
 print(roast())
 ```
 
+### Quote
+
+```python
+from funkitpy import quote
+
+print(quote())
+```
+
+### Quote Data
+
+Returns the raw quote dictionary.
+
+```python
+from funkitpy import quote_data
+
+print(quote_data())
+```
+
+Example:
+
+```python
+{
+    "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:
 
 ```python
-from funkitpy import get_joke
-from funkitpy import get_dad_joke
-from funkitpy import get_roast
+from funkitpy import (
+    get_joke,
+    get_dad_joke,
+    get_roast,
+    get_quote
+)
 ```
 
 These functions behave exactly the same as:
@@ -84,6 +117,7 @@ These functions behave exactly the same as:
 joke()
 dad_joke()
 roast()
+quote()
 ```
 
 ---
@@ -110,6 +144,12 @@ funkit dad-joke
 funkit roast
 ```
 
+### Quote
+
+```bash
+funkit quote
+```
+
 ### Show Version
 
 ```bash
@@ -124,15 +164,34 @@ funkit --version
 funkit commands
 ```
 
+Output:
+
+```text
+joke
+dad-joke
+roast
+quote
+```
+
 ---
 
 ## Example Output
 
+### Joke
+
 ```text
 Why don't scientists trust atoms?
 Because they make up everything.
 ```
 
+### Quote
+
+```text
+"The best way to get started is to quit talking and begin doing."
+
+— Walt Disney
+```
+
 ---
 
 ## Project Structure
@@ -143,12 +202,14 @@ funkitpy/
 │   ├── __init__.py
 │   ├── jokes.py
 │   ├── roasts.py
+│   ├── quotes.py
 │   ├── cli.py
 │   ├── version.py
 │   └── data/
 │       ├── jokes.json
 │       ├── dad_jokes.json
-│       └── roasts.json
+│       ├── roasts.json
+│       └── quotes.json
 ├── tests/
 ├── pyproject.toml
 ├── LICENSE
@@ -157,6 +218,18 @@ funkitpy/
 
 ---
 
+## 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.
@@ -171,12 +244,15 @@ Contributions, bug reports, and feature requests are welcome.
 ## Links
 
 Homepage:
+
 https://github.com/fmasterpro27/FunKitPy
 
 Issues:
+
 https://github.com/fmasterpro27/FunKitPy/issues
 
 PyPI:
+
 https://pypi.org/project/funkitpy/
 
 ---

funkitpy/__init__.py

@@ -1,10 +1,15 @@
-from .jokes import joke, dad_joke
+from .jokes import joke, dad_joke, get_joke, get_dad_joke
 from .roasts import roast
+from .quotes import quote, quote_data
 from .version import __version__
 
 __all__ = [
     "joke", 
     "dad_joke", 
-    "roast", 
+    "roast",
+    "quote",
+    "quote_data",
+    "get_joke",
+    "get_dad_joke",
     "__version__"
 ]

funkitpy/cli.py

@@ -2,13 +2,17 @@
 
 from .jokes import joke, dad_joke
 from .roasts import roast
-from .version import __version__
+from .quotes import quote
+from importlib.metadata import version
+
+
+__version__ = version("FunKitPy")
 
 
 def main():
     parser = argparse.ArgumentParser(
         prog="funkit",
-        description="FunKitPy - Random jokes, dad jokes and roasts",
+        description="FunKitPy - Random jokes, dad jokes, quotes and roasts",
     )
 
     parser.add_argument(
@@ -39,6 +43,11 @@ def main():
         help="Get a random roast",
     )
 
+    subparsers.add_parser(
+        "quote",
+        help="Get a random quote",
+    )
+
     subparsers.add_parser(
         "commands",
         help="List all available commands",
@@ -59,13 +68,17 @@ def main():
     elif args.command == "roast":
         print(roast())
 
+    elif args.command == "quote":
+        print(quote())
+
     elif args.command == "commands":
         print("""
 Available Commands:
 
   joke         Get a random joke
   dad-joke     Get a random dad joke
   roast        Get a random roast
+  quote        Get a random quote
   commands     Show all commands
 
 Flags:
@@ -78,6 +91,7 @@ def main():
   funkit joke
   funkit dad-joke
   funkit roast
+  funkit quote
   funkit -v
 """)
 
@@ -86,4 +100,4 @@ def main():
 
 
 if __name__ == "__main__":
-    main()
+    main()