Skip to main content

Powerful terminal expense tracker.

Project description

🥯 Bagels - TUI Expense Tracker

Powerful expense tracker that lives in your terminal.

PyPI - Version 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

Bagels can be installed via uv on MacOS, Linux, and Windows.

uv is a single Rust binary that you can use to install Python apps. It's significantly faster than alternative tools, and will get you up and running with Bagels in seconds.

You don't even need to worry about installing Python yourself - uv will manage everything for you.

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

uv can also be installed via Homebrew, Cargo, Winget, pipx, and more. See the installation guide for more information.

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 Brew
brew install bagels    
By Pipx
pipx install bagels    
By Conda
conda install -c conda-forge bagels
By X-CMD
x install 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

↔️ Migration

Please read the migration guide for migration from other services.

🛠️ 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.11.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.11-py3-none-any.whl (167.6 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for bagels-0.3.11.tar.gz
Algorithm Hash digest
SHA256 98457622324e620f0dda9d4b8f9f8ed9e182a18d947949bbead711366343266f
MD5 00a57bfc63f49fcb9e6c397e58c8db7e
BLAKE2b-256 2577f1d0981d5432158fce0f8abde4af1360e5dc6abfc0e39dbe78082c51103e

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for bagels-0.3.11-py3-none-any.whl
Algorithm Hash digest
SHA256 10c128af4a80396d9ab6ac89c4813dcc67c63afee5df6002593eae16c5a8a500
MD5 5789c8f37841a7c679444329b566580d
BLAKE2b-256 05c3006e43fd21bca4506f0bf8f3243b5e5f9f01cbfed79f31783ae07b933dff

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