Skip to main content

Powerful terminal expense tracker.

Project description

Bagels - TUI Expense Tracker

Powerful expense tracker that lives in your terminal.

Bagels

Bagels expense tracker is a TUI application where you can track and analyse your money flow, with convenience oriented features and a complete interface.

Why an expense tracker in the terminal? I found it easier to build a habit and keep an accurate track of my expenses if I do it at the end of the day, instead of on the go. So why not in the terminal where it's fast, and I can keep all my data locally?

Features

Some notable features include:

  • Accounts, (Sub)Categories, Splits, Transfers, Records
  • Templates for Recurring Transactions
  • Add Templated Record with Number Keys
  • Clear Table Layout with Togglable Splits
  • Transfer to and from Outside Tracked Accounts
  • "Jump Mode" Navigation
  • Less and Less Fields to Enter per Transaction, Powered by Transactions and Input Modes
  • Insights
  • Customizable Keybindings and Defaults, such as First Day of Week

Installation

MacOS:

# install uv (package manager):
curl -LsSf https://astral.sh/uv/install.sh | sh

# restart your terminal, or run the following command:
source $HOME/.local/bin/env # or follow instructions

# install bagels through uv
uv tool install --python 3.13 bagels

Windows:

# install uv:
powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"
# then follow instructions to add uv to path
uv tool install --python 3.13 bagels

Usage:

bagels # start bagels
bagels --at "./" # start bagels with data stored at cd
bagels locate database # find database file path
bagels locate config # find config file path

It is recommended, but not required, to use "modern" terminals to run the app. MacOS users are recommended to use Ghostty, and Windows users are recommended to use Windows Terminal.

To upgrade:

uv tool upgrade bagels

Development setup

git clone https://github.com/EnhancedJax/Bagels.git
cd Bagels
uv sync
uv run pre-commit install
mkdir instance
uv run bagels --at "./instance/" # runs app with storage in ./instance/
# alternatively, use textual dev mode to catch prints
uv run textual run --dev "./src/bagels/textualrun.py"
uv run textual console -x SYSTEM -x EVENT -x DEBUG -x INFO # for logging

Please use the black formatter to format the code.

Roadmap

  • Budgets (Major!)
  • More insight displays and analysis (by nature etc.)
  • Daily check-ins
  • Pagination for records on monthly and yearly views.

Backlog:

  • "Processing" bool on records for transactions in process
  • Record flags for future insights implementation
  • Code review
  • Repayment reminders
  • Add tests
  • Bank sync

Attributions

  • Heavily inspired by posting
  • Bagels is built with textual
  • It's called bagels because I like bagels

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

bagels-0.3.1.tar.gz (3.7 MB view details)

Uploaded Source

Built Distribution

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

bagels-0.3.1-py3-none-any.whl (160.7 kB view details)

Uploaded Python 3

File details

Details for the file bagels-0.3.1.tar.gz.

File metadata

  • Download URL: bagels-0.3.1.tar.gz
  • Upload date:
  • Size: 3.7 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.5.24

File hashes

Hashes for bagels-0.3.1.tar.gz
Algorithm Hash digest
SHA256 703ce827c149d7fa40b3c9f1126300fd2b9ae1970da5c3db1a15ded46e8ff076
MD5 86df5f742d16663b4cfc85f54d63a46f
BLAKE2b-256 56cb3f67c0468ff6500aca28608b433e811c3da06e772b075141141e215afdfb

See more details on using hashes here.

File details

Details for the file bagels-0.3.1-py3-none-any.whl.

File metadata

  • Download URL: bagels-0.3.1-py3-none-any.whl
  • Upload date:
  • Size: 160.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.5.24

File hashes

Hashes for bagels-0.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 8103bf3d5ca0c967190fb8fc28dd59d2b212ee1a31966c29d508af0270a4c842
MD5 9bdd95f47c9cd652b6f7ac4320dd301f
BLAKE2b-256 b1af6204bd46bcc2a030d244a651e72fd326a782918f7b247275ed6df88b0db1

See more details on using hashes here.

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