Git Product home page Git Product logo

fin_cli's Introduction

FIN CLI

A cli tool which categorizes my transactions based on their description using substring matching and regex.

The transactions are stored in a postgres database in which the schema is found at schema.sql

The gist of it.

The process pretty much goes like this.

  • There are categories, which you create via the database
  • There are "rules", which you specify and input via the database. Each rule specifies a specific regex or substring match condition (indicated by the rule_type column, see below) which would map a transaction's description to a category
  • The cli pulls the transactions from the database and processes them with the rules and updates them accordingly

Setup

  • Install via cargo install --path ./fin_cli
  • Setup the env variable FIN_DATABASE_URL
  • Create the database via the schema psql $FIN_DATABASE_URL -f ./schema.sql

Available functionality

  • Add transactions via csv format using fin_cli add, use fin_cli add --help, for more info
    • Currently supporting ING csv exports and simple csv exports from bendigo online banking
  • Classify all the transactions using fin_cli classify-all
  • Classify all the transactions with no categories set using fin_cli classify-uncategorised

Managing rules and categories

The cli tool doesn't support this, I personally use Noco Db to manage entries. But you can use any database client, or just raw sql.

Rule types

The current rule types must be one of

  • "REGEX"
  • "STRING_MATCH"

These are specified via the rule_type column in the rule table.

fin_cli's People

Contributors

brahms116 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.