This library is a Python client for the Lunch Money API.
This software is considered to be in Alpha state, as all endpoints of the API have not yet been implemented.
You can install this library by running
$ pip install lunchmoney
In order to use the client, you need to set the LUNCHMONEY_API_KEY enviroment variable with your API Token, which you can get by going to Settings > Developers > Request new Access Token.
from lunchmoney import LunchMoneyClient
client = LunchMoneyClient()categories = client.categories()
print(categories)
# [Category(id=214038, name='Alcohol, Bars', description=None, is_income=False, exclude_from_budget=False, exclude_from_totals=False, updated_at=datetime.datetime(2021, 6, 7, 22, 14, 6, 379000, tzinfo=datetime.timezone.utc), created_at=datetime.datetime(2021, 6, 7, 22, 14, 6, 379000, tzinfo=datetime.timezone.utc), is_group=False, group_id=None), Category(...), ...]trx_data = {
"date": "2021-06-06",
"payee": "Sushi House",
"amount": 50.99,
"currency": "usd",
}
trx_ids = client.insert_transaction(trx_data)
print(trx_ids)
# [3322341]You can also instert multiple transactions by passing a list of transactions to client.insert_transactions()
trxs = client.transactions(category_id=323401)
print(trxs)
# [Transaction(id=41078765, date='2021-06-06', amount=70.0, payee='Sushi House', currency='usd', status=<TransactionStatus.uncleared: 'uncleared'>, category_id=214038, asset_id=None, parent_id=None, plaid_account_id=None, is_group=False, group_id=None, external_id=None, tags=None, notes=None), ...]This library is still in development, and pull requests are welcome. For ideas on what to contribute, take a look at Lunch Money's API Reference, and try to implement a missing endpoint or parameter.
- Fork this repository, clone your fork, and add this repository remote as upstream.
- Run
make setupin the project directory. - Make your changes, write your tests.
- Try out your changes in the repl with
make repl. - Run
make testfor tests, andmake lintfor linting. - Once you're happy with your changes, submit a PR!