Skip to main content

Powerful terminal expense tracker.

Project description

🥯 Bagels - TUI Expense Tracker

Powerful expense tracker that lives in your terminal.

GitHub commit activity GitHub License PyPI - Downloads Terminal Trove Tool of The Week

Bagels 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
  • Label, amount and category filtering
  • Spending plottings / graphs with estimated spendings
  • Budgetting tool for saving money and limiting unnecessary spendings

📦 Installation

Recommended: By UV

Unix / 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:
winget install --id=astral-sh.uv  -e
# then follow instructions to add uv to path
uv tool install --python 3.13 bagels
By Pipx
```bash
pipx install bagels
```
By Conda
```bash
conda install -c conda-forge 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 with uv:

uv tool upgrade bagels

🛠️ Development setup

git clone https://github.com/EnhancedJax/Bagels.git
cd Bagels
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.
  • Importing from various formats

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.4.tar.gz (3.6 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.4-py3-none-any.whl (162.1 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for bagels-0.3.4.tar.gz
Algorithm Hash digest
SHA256 e487d9562c10ddc056d42db81dae07bfe92837e78f6ef07046f202a385263520
MD5 c30d3ec2342c327c0cb2548d404f4949
BLAKE2b-256 c0c8466d4a758e4e66ad06a7ec8427104eb94dfe684ad7318555467091b7e0f2

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for bagels-0.3.4-py3-none-any.whl
Algorithm Hash digest
SHA256 44b96aa4bea0ff33b6294f0cc440662dd88a5a384f6061aee300fc95594da2ef
MD5 ea43062b1443db82c81bde4f97716def
BLAKE2b-256 2894be3b7f214b30e3d2f622515da87199beaf6d8dde0bed319a394830ab6797

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