https://github.com/vipul-sharma20/hdfc-analytics
CLI to analyze HDFC account and credit card statement
https://github.com/vipul-sharma20/hdfc-analytics
banking expense-tracker expenses hdfc hdfc-bank
Last synced: 6 months ago
JSON representation
CLI to analyze HDFC account and credit card statement
- Host: GitHub
- URL: https://github.com/vipul-sharma20/hdfc-analytics
- Owner: vipul-sharma20
- License: mit
- Created: 2023-11-11T16:51:46.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2025-03-22T17:47:59.000Z (7 months ago)
- Last Synced: 2025-04-10T14:46:52.946Z (6 months ago)
- Topics: banking, expense-tracker, expenses, hdfc, hdfc-bank
- Language: Python
- Homepage:
- Size: 760 KB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## hdfc-analytics
Get analysis of HDFC bank account and credit card statement
Expenses by Category
### Usage
1. Install CLI
```
pip install https://github.com/vipul-sharma20/hdfc-analytics/releases/download/v0.3.0/hdfc_analytics-0.3.0-py3-none-any.whl
```
(check releases for latest whl releases)
2. Prepare bank statement data. Check the configuration section below
3. Run the CLI
**Account Statement Analysis**
```
hdfc-analytics account --statement-csv=./configs/generated_statement.csv --categories-config=./configs/categories.toml --column-config=./configs/column_mapping.toml
```
**Credit Card Statement Analysis**
```
hdfc-analytics cc --statement-dir=./path-to-cc-statements/ --categories=./config/categories.toml --column-config=./configs/column_mapping.toml --name="JOHN DOE" --password=JOHN1211
```
Look at [`configs/`][configs] directory for sample configs and
[more documentation][configuration-doc] later in the doc.
#### LLM for tagging
If you cannot manually build a categories config, you can use LLM to tag your
transactions. Use the `--llm` flag.
You can give the model name in the `--llm` flag which is of the format
`/`. You can also check how [litellm][litellm] supports
model names. I have tested this with OpenAI, Anthropic & a few models on Groq.
```
hdfc-analytics account --statement-csv=./configs/generated_statement.csv --categories-config=./configs/categories.toml --column-config=./configs/column_mapping.toml --llm=openai/gpt-4o
```
> [!NOTE]
> I would recommend using a self-hosted LLM for tagging if you opt for LLMs to
> tag your transactions. Please don't give your data to anyone else.
You can use the `--llm-host` tag along with `--llm` in case you are planning to
use some self-hosted Ollama models.
```
hdfc-analytics account --statement-csv=./configs/generated_statement.csv --categories-config=./configs/categories.toml --column-config=./configs/column_mapping.toml --llm=ollama/llama3.2 --llm-host=http://localhost:11434
```
---
### Configuration
Sample set of configurations can be found in [`configs/`][configs] directory.
1. **Statement**: HDFC provides bank statement in XLS format. Download and
convert your statement to the format as defined in the
[sample statement][sample-statement]. You'll only need to remove a few rows
at the top and at the bottom of the generated statement. Clean and save it
to a csv file
2. **Columns**: This configuration stores custom column names to be mapped for
the generated sheet columns. Sample config [here][sample-column].
3. **Categories**: This configuration defines some list of strings under a
category that the script tries to match and categorize each transactions
into. Sample config [here][sample-categories].
---
> [!WARNING]
> This is an open-source code. While there's no shady business happening in the
> code, I strongly suggest to use this at your own discretion. I strongly
> suggest all users to thoroughly vet and test the code before integration into
> any project or use in a production environment. I offer the code as-is and
> make no representations regarding its correctness, reliability, or safety
[configs]: https://github.com/vipul-sharma20/hdfc-analytics/tree/main/configs
[sample-statement]: https://github.com/vipul-sharma20/hdfc-analytics/blob/main/configs/statement.csv
[sample-column]: https://github.com/vipul-sharma20/hdfc-analytics/blob/main/configs/column_mapping.toml
[sample-categories]: https://github.com/vipul-sharma20/hdfc-analytics/blob/main/configs/categories.toml
[litellm]: https://github.com/BerriAI/litellm
[configuration-doc]: https://github.com/vipul-sharma20/hdfc-analytics/tree/llm-tagging?tab=readme-ov-file#configuration
[credit-card-feature]: https://github.com/vipul-sharma20/hdfc-analytics/issues/1