Skip to content

README.md

Latest commit

 

History

History
164 lines (122 loc) · 5.69 KB

README.md

File metadata and controls

164 lines (122 loc) · 5.69 KB

霄占 (Fortune Teller)

██╗  ██╗██╗ █████╗  ██████╗      ███████╗██╗  ██╗ █████╗ ███╗   ██╗
╚██╗██╔╝██║██╔══██╗██╔═══██╗     ╚══███╔╝██║  ██║██╔══██╗████╗  ██║
 ╚███╔╝ ██║███████║██║   ██║       ███╔╝ ███████║███████║██╔██╗ ██║
 ██╔██╗ ██║██╔══██║██║   ██║      ███╔╝  ██╔══██║██╔══██║██║╚██╗██║
██╔╝ ██╗██║██║  ██║╚██████╔╝     ███████╗██║  ██║██║  ██║██║ ╚████║
╚═╝  ╚═╝╚═╝╚═╝  ╚═╝ ╚═════╝      ╚══════╝╚═╝  ╚═╝╚═╝  ╚═╝╚═╝  ╚═══╝

✨ Ancient Wisdom at Your Fingertips / 古今命理，尽在掌握 ✨

English | 中文

A terminal fortune telling app that combines classical divination systems with modern LLMs. Streamed readings, bilingual UI, arrow-key navigation.

🌟 Features

  • 🀄 BaZi (八字命理) — Traditional Chinese four-pillars reading driven by birth date/time
  • 🃏 Tarot — Card draws with several spreads and interpretation
  • ⭐ Western Astrology — Sun-sign analysis by birth date
  • 💬 Follow-up chat — Ask deeper questions after the main reading (career, relationships, health, timing…)
  • 🌍 Bilingual — English / 中文, selectable at launch or via --lang
  • ⌨️ Arrow-key menus — Falls back to numeric prompt when stdin isn't a TTY
  • ⚡ Real streaming — Tokens stream directly from the LLM; a spinner covers first-token latency
  • 🔌 Multi-provider LLM — AWS Bedrock (Claude), Anthropic direct, OpenAI, DeepSeek

🚀 Quick Start

# 1. Clone
git clone https://github.com/YuchengMaUTK/fortune-teller.git
cd fortune-teller

# 2. Install dependencies
python -m venv .venv && source .venv/bin/activate
pip install -r requirements.txt

# 3. Configure
cp config.yaml.example config.yaml
# Edit config.yaml — pick a provider, plug in credentials. See below.

# 4. Run
python -m fortune_teller

Useful flags:

python -m fortune_teller --lang en        # skip the language picker
python -m fortune_teller --system bazi    # skip the system picker
python -m fortune_teller --list           # list available systems
python -m fortune_teller --verbose        # enable console logging

🔧 Configuration

All configuration lives in config.yaml. The example file documents every provider; pick one llm: block.

AWS Bedrock (recommended)

llm:
  provider: aws_bedrock
  model: us.anthropic.claude-sonnet-4-5-20250929-v1:0
  region: us-west-2
  temperature: 0.7
  max_tokens: 2000
  # profile: my-profile    # optional named ~/.aws profile

Credentials are resolved by the boto3 default chain:

  1. Explicit aws_access_key / aws_secret_key in config.yaml
  2. profile: field pointing at a named AWS profile
  3. Environment variables (AWS_ACCESS_KEY_ID, AWS_PROFILE, …)
  4. ~/.aws/credentials default profile, SSO, IMDS, credential_process, …

If aws sts get-caller-identity works in your shell, the connector will work too.

Anthropic direct

llm:
  provider: anthropic
  model: claude-sonnet-4-5-20250929

Reads the key from ANTHROPIC_API_KEY.

OpenAI

llm:
  provider: openai
  model: gpt-4o-mini

Reads the key from OPENAI_API_KEY.

DeepSeek

llm:
  provider: deepseek
  model: deepseek-chat

Reads the key from DEEPSEEK_API_KEY.

🎮 Usage

  1. Pick a language (arrow keys / q to quit)
  2. Pick a fortune system
  3. Fill in the prompted information — birth date/time, question, spread
  4. Watch the reading stream in
  5. After the main reading, pick a follow-up topic for a deeper analysis, or chat freely with 霄占

🏗️ Architecture

fortune_teller/
├── main.py              # CLI entry point, interactive menu, follow-up, chat
├── core/
│   ├── llm_connector.py # Unified LLM dispatch (Bedrock/Anthropic/OpenAI/DeepSeek)
│   ├── aws_connector.py # Bedrock streaming + non-streaming
│   ├── config_manager.py
│   ├── plugin_manager.py
│   └── mock_connector.py
├── plugins/             # Fortune systems (each ships its own prompts + data)
│   ├── bazi/
│   ├── tarot/
│   └── zodiac/
├── tools/
│   ├── llm_tool.py      # LLMTool wrapper (reads config.yaml)
│   └── mcp_tools.py     # Subprocess wrapper around mcp/tools/*.py
├── ui/
│   ├── keyboard_input.py # Arrow-key menus, TTY-aware
│   ├── display.py        # Streaming printer, headers, animations
│   └── animation.py
└── i18n/
    └── locales/         # en.json / zh.json

mcp/tools/ at the repo root contains the pure-Python calculators for BaZi pillars, tarot draws, and zodiac signs; they're CLI scripts that tools/mcp_tools.py shells out to.

🤝 Contributing

See CONTRIBUTING.md for the development setup, coding conventions, and guidance for adding new fortune systems or translations.

📄 License

MIT — see LICENSE.

🙏 Acknowledgments

  • Traditional Chinese fortune-telling lore
  • Anthropic, OpenAI, AWS Bedrock, DeepSeek — the LLMs doing the heavy lifting
  • Everyone who opened an issue or sent a PR

Ancient wisdom, modern plumbing. Enjoy. ✨