whatsmynote 0.1.3

WhatsMyNote

An intelligent, fully conversational financial memory system.
Control your lending, borrowing, expenses, income, and transfers through pure natural language right from your terminal.

View on PyPI · Report Bug · Request Feature

📑 Table of Contents

• About The Project
  • Architecture & Tech Stack
• Getting Started (For Users)
  • Installation
  • First Run & Authentication
• Documentation & Features
• Local Development (For Contributors)
• License

🌟 About The Project

Tracking finances shouldn't require complex spreadsheets, clunky UIs, or manual data entry. WhatsMyNote brings the power of state-of-the-art Large Language Models (LLMs) directly to your terminal.

Just type what happened naturally. The AI will instantly parse your intent, validate the transaction using a Human-in-the-Loop mechanism (if it's complex), and persist it securely to your database.

Say goodbye to manual tracking:

"I spent $15 on coffee today using my HDFC account."
"My friend John borrowed $50 from me for lunch."
"Show me my expenses for this month as a chart."

🏗 Architecture & Tech Stack

WhatsMyNote uses a powerful Multi-Agent Architecture powered by LangGraph. A Supervisor agent routes your query to the exact specialist agent needed to handle your request.

graph TD
    User([User CLI Input]) --> Supervisor[Supervisor Agent]
    
    Supervisor -->|Routing| Classifier[Classifier Agent]
    Classifier -->|Classified Intent| SpecialistAgents
    
    subgraph SpecialistAgents[Specialist Agents]
        AccountAgent[Account Agent]
        BudgetAgent[Budget Agent]
        ExpenseAgent[Expense Agent]
        IncomeAgent[Income Agent]
        LendingAgent[Lending Agent]
        TransferAgent[Transfer Agent]
    end
    
    SpecialistAgents --> Validate{Human-in-the-Loop Validation}
    
    Validate -->|Requires Details| Clarify[Ask User for Details]
    Clarify --> User
    
    Validate -->|Confirmed| DB[(PostgreSQL Database)]
    
    Supervisor -->|Analytics Query| SQLAgent[Text-to-SQL Agent]
    SQLAgent --> DB
    DB --> SQLAgent
    SQLAgent --> Output([CLI Rich Chart / Table])
    
    DB --> Output([Success Message])

• Language: Python
• AI/LLM Framework: LangGraph, LangChain, Groq (Llama-3)
• Data Validation: Pydantic
• Database & Persistence: SQLAlchemy & PostgreSQL (hosted on Render/Supabase)
• Authentication: Supabase OAuth (Google/GitHub)
• CLI UI: Rich

Deep Dive: Check out the Core Concepts & Architecture page for a full breakdown of the multi-agent system.

🚀 Getting Started (For Users)

Installation

The recommended way to install WhatsMyNote is directly from PyPI. Ensure you have Python 3.11+ installed.

# We highly recommend using uv for lightning-fast installation!
uv tool install whatsmynote

# Or standard pip:
pip install whatsmynote

First Run & Authentication

After installing, simply type the command below in your terminal:

whatsmynote

1. You will be prompted to log in via your browser using Supabase (Google/GitHub).
2. The CLI will securely store your token locally.
3. The AI will guide you through setting up your first Default Account and your monthly Budgets.
4. You are ready to chat!

Full Guide: Read the Getting Started Guide for detailed CLI examples and screenshots.

📚 Documentation & Features

WhatsMyNote supports an extensive array of financial primitives. Dive into the detailed documentation for each capability below:

🛠 Local Development (For Contributors)

If you'd like to contribute to the codebase or run the backend completely locally, you'll need uv installed.

1. Clone the repo:

   git clone https://github.com/SarJ2004/WhatsMyNote.git
   cd WhatsMyNote
   

2. Environment Setup:

   cp .env.sample .env
   

   You will need to provide your own GROQ_API_KEY and Supabase keys in the .env file.

   Important: For DATABASE_URL, use the Supabase Direct connection (Port 5432 or Session mode). Do NOT use the Transaction Pooler (Port 6543), as it breaks SQLAlchemy schema migrations during initial setup.

3. Install Dependencies:

   uv pip install -e .
   

4. Run the Backend locally:

   uv run uvicorn backend.main:app --reload
   

5. Test the CLI: Open a new terminal window, ensure ENV="dev" is in your .env, and run:

   uv run whatsmynote
   

📄 License

Distributed under the MIT License. See LICENSE for more information.