MinimalFinanceTracker

A simple expense tracking application for single household use.

Setup

It's recommended to install in a virtual environment. The extra dev dependencies can be optionally installed.

# Create and activate the virtual environment
python -m venv venv
source ./venv/bin/activate

# Install an editable version for development, including the optional
# development dependencies
pip install -e .[dev]

# Or otherwise just install the application:
pip install .

Running the Application

After activating the virtual environment and installing the python package you can use the mft command to run and manage the service.

# Print cli help
mft --help
mft run --help
# Run the server using the default config file location
mft run
# Run the server using a specified config file
mft --config /path/to/cfg.toml run
# Run the server in debug/development mode, making it reload itself when the
# files change
mft run --debug

The config file must exist, but it may be empty.