README.md

lunchable

lunchable is a Python Client for the Lunch Money Developer API. It's built on top of pydantic and httpx, it offers an intuitive API, a simple CLI, complete coverage of all endpoints, and a plugin framework for extending the functionality of the library.

Installation

pip install lunchable

Usage

from typing import Any, Dict, List

from lunchable import LunchMoney
from lunchable.models import TransactionObject

lunch = LunchMoney(access_token="xxxxxxxxxxx")
transactions: List[TransactionObject] = lunch.get_transactions()

first_transaction: TransactionObject = transactions[0]
transaction_as_dict: Dict[str, Any] = first_transaction.model_dump()

CLI

To use the CLI, you'll need to set the LUNCHMONEY_ACCESS_TOKEN environment variable. It's recommended to use pipx to install the CLI - use the lunchable[plugins] extra to include all the known plugins:

pipx install "lunchable[plugins]"

export LUNCHMONEY_ACCESS_TOKEN="xxxxxxxxxxx"
lunchable transactions get --limit 5
lunchable http -X GET v1/assets

Check out the Docs

Looking to contribute? See the Contributing Guide

See the Changelog

---

---