Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/nitinn77/credit-card-spends-tracker

An open source CLI tool to fetch and store your credit card transaction details from your inbox
https://github.com/nitinn77/credit-card-spends-tracker

credit-card go golang india spending-tracker

Last synced: about 1 month ago
JSON representation

An open source CLI tool to fetch and store your credit card transaction details from your inbox

Awesome Lists containing this project

README 

        
# Credit Card Spends Tracker (WIP)



A CLI tool to fetch and store your credit card transaction details from your inbox. (India only)



The motivation behind this is to avoid the usage of proprietary apps like CRED or Axio that offer similar functionality but might sell your data. This application is open source and can be built from source if you feel the need to do so.

An alternative would be an open source mobile application that reads your SMS data, which seems to have convuluted permission issues. I made this for myself to quickly check my spending across all my cards.



It does this by making use of the [Gmail API](https://developers.google.com/gmail/api/guides/) to fetch your emails using your own GCP credentials ensuring that you're the only one with access to your emails.



## Features



- Fetch and view your credit card transactions between any date range (currently supports Axis and HDFC cards).

- Displays spend totals by credit card and merchant.

- Fetch transactions filtered by a merchant, optionally within a specified date range

- Caches fetched transactions in a local SQLite database to prevent duplicate fetch calls in the future.

- Allows you to manually add aliases for merchant names for better organization of your transactions.



## Quickstart



1. Clone the repo and create a file named `config.toml` in the root directory. Copy the contents of `config.toml.example` into it and edit `user_email` to your email and edit `axis_card_details` and `hdfc_card_details` to match your cards.

2. Run `go build .` to build the application.

3. Follow [these](https://developers.google.com/gmail/api/quickstart/go#set_up_your_environment) steps till you get your hands on your `credentials.json` file (Follow till Step 7 of "Authorize credentials for a desktop application"). Ensure this file is in the root directory.

4. Run `.\credit-card-spends-tracker.exe --fetch 2024-10-10 2024-10-14` (fetches transactions between Oct 10th and Oct 14th)

5. During the first time set up, you will have to log in to your respective Google account as prompted by the application. This involves providing Gmail API access to the GCP project you created. The application will either automatically authenticate itself or you will have to manually copy the code and paste it into your console. [Troubleshooting](#troubleshooting)



## Commands



1. Fetch transactions between two dates (inclusive).



`credit-card-spends-tracker.exe --fetch {YYYY-MM-DD} {YYYY-MM-DD}`



Example: `.\credit-card-spends-tracker.exe --fetch 2024-10-10 2024-10-14`



2. Add an alias for a merchant.



`credit-card-spends-tracker.exe --alias {alias} {merchant_name}`



Example: `.\credit-card-spends-tracker.exe --alias "WWW SWIGGY COM" "Swiggy"`



3. Fetch transactions filtered by a merchant



`credit-card-spends-tracker.exe --filter {merchant}`



Example: `.\credit-card-spends-tracker.exe --filter Swiggy`



4. Fetch transactions filtered by a merchant within a date range (inclusive)



`credit-card-spends-tracker.exe --filter {merchant} {YYYY-MM-DD} {YYYY-MM-DD}`



Example: `.\credit-card-spends-tracker.exe --filter Swiggy 2024-10-10 2024-10-12`



> [!NOTE]  

> An alias is a merchant tag used by a merchant in a transaction email. A merchant can have multiple aliases which requires us to store known aliases for proper categorization.



## Roadmap



1. Add error handling for improper CLI arguments

2. Add unit tests

3. Improve stdout formatting



## Troubleshooting



- If you get an "Unable to connect" error page after following the steps to authenticate, copy the string in between `code=` and `&scope` in the current page URL and paste it into your console.