kathekon 0.0.6

kathekon is a Python library and CLI tool for fetching Stoic quotes with interpretations.

kathekon

kathekon is a Python library and CLI tool for exploring Stoic philosophy through curated quotes. It allows you to fetch random or daily quotes, insert quotes into files like README.md, and generate thoughtful interpretations using OpenAI.

---

Features

• Fetch Quotes:

  • Retrieve random Stoic quotes or specific quotes by author or ID.
  • Generate consistent daily quotes based on the day of the year.
  • Fetch multiple quotes at once for broader inspiration.

• CLI Tool:

  • Display quotes in the terminal with elegant formatting.
  • Update files (e.g., README.md) with quotes and their interpretations.
  • Customize quote fetching using multiple filtering options.

• OpenAI Integration (Optional):

  • Generate thoughtful interpretations of quotes using OpenAI's GPT models.

• Library Integration:

  • Use Quotes from the library to integrate Stoic philosophy into your projects.

---

Installation

Install kathekon using pip:

pip install kathekon

To include OpenAI features, install with the [openai] or [all] extras:

pip install kathekon[openai]
pip install kathekon[all]

---

Usage

CLI Commands

After installation, you can use the CLI commands kathekon or stoic-quote.

Display a Random Quote

kathekon --author "Marcus Aurelius"

Display Today’s Quote

kathekon daily

Insert a Quote into README.md

Ensure your README.md includes markers like this:

<!--START_SECTION:quote-text-->
<!--END_SECTION:quote-text-->

<!--START_SECTION:quote-author-->
<!--END_SECTION:quote-author-->

<!--START_SECTION:quote-interpretation-->
<!--END_SECTION:quote-interpretation-->

Then, insert a random or daily quote:

# Insert a random quote by Marcus Aurelius
kathekon readme random --file README.md --author "Marcus Aurelius"

# Insert today’s Stoic quote
kathekon readme daily --file README.md

Available CLI Arguments

General Options

Argument	Description	Default
--id ID	Fetch a quote by its unique ID	None
--author "Author Name"	Fetch a random quote by the specified author	None
--interpretation INTERPRETATION	Choose method to fetch or generate interpretation: gpt, db, gpt+fallback, db+fixed	db

Interpretation Methods Explained

Method	Description
gpt	Generate a quote interpretation using OpenAI's GPT models. Requires an API key.
db	Fetch an (random) existing interpretation from the database.
gpt+fallback	Try generating an interpretation using GPT. If unavailable, fall back to a database interpretation.
db+fixed	Use a fixed interpretation from the database, ensuring consistency for daily quotes.

daily Command

Argument	Description	Default
--interpretation INTERPRETATION	Choose method to fetch or generate interpretation: gpt, db, db+fixed, gpt+fallback	db+fixed

readme random Command

Argument	Description	Default
--file FILE	Path to the file to update	README.md
--id ID	Fetch a quote by its unique ID	None
--author "Author Name"	Fetch a random quote by the specified author	None
--interpretation INTERPRETATION	Choose method to fetch or generate interpretation: gpt, db, gpt+fallback	db

readme daily Command

Argument	Description	Default
--file FILE	Path to the file to update	README.md
--interpretation INTERPRETATION	Choose method to fetch or generate interpretation: gpt, db, db+fixed, gpt+fallback	db+fixed

---

Library Usage

Fetch a Random Quote

from kathekon import Quotes

quotes = Quotes()
quote = quotes.get_quote(author="Epictetus")
print(f"{quote.text} — {quote.author}")

Generate Today’s Quote

daily_quote = quotes.get_daily_quote(interpretation="gpt+fallback")
print(f"{daily_quote.text} — {daily_quote.author}")
print(f"Interpretation: {daily_quote.interpretation}")

Fetch Multiple Quotes

You can fetch multiple quotes at once with optional filters like author, limit, or interpretation.

from kathekon import Quotes

quotes = Quotes()

# Fetch up to 5 random quotes
for quote in quotes.get_quotes(limit=5):
    print(f"{quote.text} — {quote.author}")

# Fetch 3 quotes by Seneca with interpretations from the database
for quote in quotes.get_quotes(author="Seneca", limit=3, interpretation="db"):
    print(f"{quote.text} — {quote.author}")
    print(f"Interpretation: {quote.interpretation}")

---

OpenAI Integration

To enable OpenAI-powered interpretations, set your API key in the OPENAI_API_KEY environment variable:

export OPENAI_API_KEY="your-api-key"

Then, use the CLI or library to fetch quotes with AI-generated interpretations.

---

Contributing

Contributions are welcome! Feel free to submit issues or pull requests on the GitHub repository.

---

Acknowledgements

The Stoic quotes used in this project are sourced from benhoneywill/stoic-quotes.

---

License

kathekon is licensed under the MIT License. See LICENSE for details.