Skip to main content

Simple finances needs made simple

Project description

ngtonic

Personal finances on your terminal

CI PyPI - License Linux PyPI - Python Version

๐ŸŒŸ Motivation and Description

Ngtonic is a small tool created to manage personal finances directly from the terminal, avoiding the need to share sensitive financial data with third-party apps. It's tailored for my specific needs. Currently, Ngtonic only supports ING bank, leveraging its automatic categorization of movements.

I also created it as an example of building a project "the right way" on GitHub.

๐Ÿค” Why Use Ngtonic?

Consider using Ngtonic if you:

  • Prefer not to use apps like Fintonic
  • Primarily use ING for personal expenses
  • Want a simple, terminal-based tool to check your finances
  • Value privacy and keeping your financial data local

For those seeking more advanced features or a GUI, Firefly III might be a better option.

๐Ÿ‘จโ€๐Ÿ’ป Getting started

  1. Install using pipx (recommended) or pip:
pipx install ngtonic
  1. Download your ING account movements as an Excel file.

  2. Import the movements:

ngtonic import movements.xls

Your data is now stored locally in .ngtonic/movements.json. You can import multiple files; Ngtonic will automatically deduplicate the data.

๐Ÿ“Š Usage

Ngtonic offers several commands:

โ•ญโ”€ Commands โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ•ฎ
โ”‚ import         Import movements files to the internal storage (only ING is supported)   โ”‚
โ”‚ list           Show a table listing the movements with optional filtering               โ”‚
โ”‚ balance-plot   Plot the evolution of the balance over time                              โ”‚
โ”‚ month-plot     Plot the movements grouped per month                                     โ”‚
โ”‚ find-bills     Use a simple heuristic to find regular bills, like subscriptions         โ”‚
โ•ฐโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ•ฏ
# Use category filtering to list home expenses
ngtonic list -c hogar

# List leisure expenses by month
ngtonic list -c ocio -m

# Check Steam purchases by month
ngtonic list -d steam -m

# Use the integrated heuristic to find regular bills
ngtonic find-bills

The plot commands enable you to visualize movements grouped by month or track the balance over time. You can apply the same filters available in the list command to customize these plots. Below are some example graphs (y axis has been removed for privacy).

# Income per mont (in my case, the payroll)
ngtonic month-plot -i
# Expenses on ocio category per month
ngtonic month-plot -c ocio
# The month-plot without any options is a good way to know your saving capacity
ngtonic month-plot
# And the balance plot will give you a more detailed way to check your cash flow
ngtonic balance-plot

โš™๏ธ Configuration

Excluding Movements

Sometimes you may want to exclude certain transactions from your analysis, such as:

  • Transfers between your own accounts or to other banks
  • Large one-time transactions that skew your graphs
  • Any movements you don't want to include in your financial overview

You can exclude these movements using the configuration file located at .ngtonic/config.yaml. This file contains a list of filters; any movement matching these filters will be excluded from all commands.

Example configuration:

excluded_movements:
  - category: "Inversiรณn"
  - subcategory: "Ingresos de otras entidades"
  - description: "Traspaso emitido Cuenta Nรณmina"
  - description: "steam"
    value: -675 # Excludes only this specific Steam transaction

๐Ÿ› ๏ธ Development

pdm install
$(pdm venv activate)
pre-commit install

This command will create a virtual environment, install all dependencies (including Ngtonic itself), and set up helpful commit hooks. Any changes made to the code will take effect immediately without requiring reinstallation.

You can also run manually the linter with pdm lint or the formatter with pdm format.

๐Ÿ“ฆ Releases

The python packages are uploaded from the CI when creating a release, but you can create an whl locally with pdm build.

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

ngtonic-0.1.3.tar.gz (9.6 kB view details)

Uploaded Source

Built Distribution

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

ngtonic-0.1.3-py3-none-any.whl (9.4 kB view details)

Uploaded Python 3

File details

Details for the file ngtonic-0.1.3.tar.gz.

File metadata

  • Download URL: ngtonic-0.1.3.tar.gz
  • Upload date:
  • Size: 9.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for ngtonic-0.1.3.tar.gz
Algorithm Hash digest
SHA256 591f12252de3cd26103d06267cad6238da7e92ae76d9b3f2d8be391db2847c17
MD5 1d88dc347c976544943cafb05f7c5b2d
BLAKE2b-256 b6a7d7ac3be122d41b4b7935283d8c7c0499da16f6dac62fac1985f7b6b158e0

See more details on using hashes here.

Provenance

The following attestation bundles were made for ngtonic-0.1.3.tar.gz:

Publisher: release.yml on dpaneda/ngtonic

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file ngtonic-0.1.3-py3-none-any.whl.

File metadata

  • Download URL: ngtonic-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 9.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for ngtonic-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 e1d93dd644a5977598ab494e410acb3da90cfbecac493e0c754ecdf0c40f0951
MD5 6726659283ff86c64ada71c3d59a2b40
BLAKE2b-256 3856c19f96848ae9c724ee32a861fddd1eb39300c7b7edb6a64ee2612453bdc7

See more details on using hashes here.

Provenance

The following attestation bundles were made for ngtonic-0.1.3-py3-none-any.whl:

Publisher: release.yml on dpaneda/ngtonic

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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