Skip to main content

A CLI app for managing notes and finances using LLMs.

Project description


Logo

WhatsMyNote

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

View on PyPI · Report Bug · Request Feature

PyPI Version License: MIT Python Versions Forks Stars


📑 Table of Contents


🌟 About The Project

Tracking finances shouldn't require complex spreadsheets or clunky UIs. WhatsMyNote brings the power of state-of-the-art Large Language Models (LLMs) directly to your terminal. Just type what happened naturally, and the AI will extract the financial intent, validate it, and persist it to a database securely.

🏗 Built With

  • Python for core logic
  • LangGraph & LangChain for robust stateful intent routing and HITL (Human-in-the-Loop) flows
  • Pydantic for extraction validation
  • SQLAlchemy & PostgreSQL for data persistence
  • Groq LLMs (Llama 3) for lightning-fast, high-quality inference
  • Supabase for secure Authentication

🚀 Getting Started

Prerequisites

You need Python 3.11 or higher installed on your machine.

Installation

The recommended way to install WhatsMyNote is directly from PyPI.

pip install whatsmynote

That's it!


💡 Usage

After installing, simply type whatsmynote in your terminal to start the conversational interface!

whatsmynote

On your very first run, it will automatically prompt you for your GROQ_API_KEY and securely save it. It will also help you set up your initial budgets and accounts.

Example Commands you can type:

  • "I spent $15 on coffee today"
  • "My friend John borrowed $50 from me"
  • "Show me my expenses for this month"
  • "Transfer $100 from Checking to Savings"

🛠 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
    
  2. Set up your environment variables:
    cp .env.sample .env
    
    Fill in your database and API keys in .env.
  3. Install all dependencies (including backend AI and DB libraries):
    uv sync
    
  4. Run the app:
    python whatsmynote/app/chat.py
    

🗺 Roadmap

See the open issues for a list of proposed features and known issues. See CHANGELOG.md for version history.


📄 License

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

whatsmynote-0.1.1.tar.gz (14.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

whatsmynote-0.1.1-py3-none-any.whl (14.8 kB view details)

Uploaded Python 3

File details

Details for the file whatsmynote-0.1.1.tar.gz.

File metadata

  • Download URL: whatsmynote-0.1.1.tar.gz
  • Upload date:
  • Size: 14.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for whatsmynote-0.1.1.tar.gz
Algorithm Hash digest
SHA256 689286ce5e618b65803ae03fb8fea57f597fb2d37c11d82b2c8cbf13b4404764
MD5 3ffc35a82c6b9befb6447f9cc1a3d21e
BLAKE2b-256 81f8e82a9d9298ab46d406c8cab2fe82e41d52bdecd33301348820c99a9950a1

See more details on using hashes here.

Provenance

The following attestation bundles were made for whatsmynote-0.1.1.tar.gz:

Publisher: release.yml on SarJ2004/WhatsMyNote

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file whatsmynote-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: whatsmynote-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 14.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for whatsmynote-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 2874e521e390740422e90bbc2cbec784d63c2c48d0b19fce85c6c4c1599c2671
MD5 cdbb110cb3b53f2b075fe3e9dd1034bd
BLAKE2b-256 623bea8308f5a910e5072dcce77f75126f356caa17bfbb1cfb83bce917fe29b8

See more details on using hashes here.

Provenance

The following attestation bundles were made for whatsmynote-0.1.1-py3-none-any.whl:

Publisher: release.yml on SarJ2004/WhatsMyNote

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page