banksaurus

module
v0.0.0-...-97d844a Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 2, 2021 License: MIT

README

** >>>>> NO LONGER SUPPORTED <<<<< **

Go Report Card

Banksaurus

When managing your finances you must ask yourself, where does your money go?

This is a personal finance manager driven mainly by fun.

Current status

This is a work in progress and is mainly a way to learn software stuff.

For now, it offers only a command line interface.

Currently it works only with Caixa Geral de Depositos exported csv file. Login into your account and export the csv file with your account movements.

How to use

Install

These instructions assume you are using Ubuntu 18.04. Run the following on your shell:

sudo apt-get update
sudo apt-get install golang
go get -u github.com/luistm/banksaurus/cmd/bscli
echo "PATH=$PATH:~/go/bin" >> ~/.bashrc
source ~/.bashrc
Available commands
$ bscli --help

    Your command line finance manager.

Usage:
	bscli -h | --help
	bscli report
	bscli report --input <file> [ --grouped ]
	bscli load --input <file>
	bscli seller change <id> --pretty <name>
	bscli seller show

Options:
	--grouped     The report is present grouped by seller
	--input       The path to the records list.
	--name        Specifies the name.
	-h --help     Show this screen.

Contributing

Although this is mainly a way to learn Go, contributions are greatly appreciated.

Setup for development

If you're interested in hacking or trying banksaurus, first change directory.:

go get -u github.com/luistm/banksaurus/cmd/bscli
cd ~/go/src/github.com/luistm/banksaurus

You will need to upgrade to go 1.13.

To run tests, execute the following:

make tests

For help about make commands just type:

make

Directories

Path Synopsis
banksauruslib
entities/transaction
Package transaction.
Package transaction.
usecases/changesellername
Package changesellername allows to change the name of the seller
Package changesellername allows to change the name of the seller
usecases/listtransactionsgrouped
Package listtransactionsgrouped shows all transactions grouped by seller
Package listtransactionsgrouped shows all transactions grouped by seller
usecases/loadtransactions
Package loadtransactions loads data to be persisted
Package loadtransactions loads data to be persisted
cmd
api
bscli/adapter/cgdgateway
Package cgdgateway fetches transactions from CGD formatted csv file
Package cgdgateway fetches transactions from CGD formatted csv file
bscli/adapter/sellergateway
Package sellergateway contains gateways for relational databases
Package sellergateway contains gateways for relational databases
bscli/command
Package command contains the commands for the command line interface
Package command contains the commands for the command line interface

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL