Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
yiufung committed Oct 27, 2019
1 parent 6a259c3 commit 5e3eb73
Showing 1 changed file with 17 additions and 8 deletions.
25 changes: 17 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,19 @@
# Beancount/CSV parser for Hang Seng e-Statement / MPower MasterCard
# Beancount/CSV parser for HK Bank Accounts

[![PyPI version fury.io](https://badge.fury.io/py/beancount-hangseng.svg)](https://pypi.python.org/pypi/beancount-hangseng/)

Parse Hang Seng (Hong Kong) Integrated Account e-Statement PDF / MPower
MasterCard, output results as beancount or CSV. For Hang Seng Integrated Account
eStatements, only **Savings** account is supported at the moment.
Few Hong Kong Banks provide structured formatted (CSVs, OFX, etc) electronic
statements to users, usually only PDFs are available (unless you're a
Business-tier user).

This package parses PDF eStatements from some of the HK Banks, and output
results as **beancount** or **CSV**.

Currently supports:

- Hang Seng Integrated Account (Only **Savings** transactions are extracted)
- Hang Seng MPOWER Credit Card
- DBS COMPASS VISA Credit Card

## Installation

Expand All @@ -21,19 +30,19 @@ eStatements, only **Savings** account is supported at the moment.

### Beancount

1. Add `HangSengSavingsImporter`/`MPowerMasterImporter` to your import config
(See [config.py](https://github.com/yiufung/beancount-hangseng/blob/master/config.py) for example)
1. Add `HangSengSavingsImporter`/`MPowerMasterImporter`/`DBSImporter` to your
import config (See [config.py](https://github.com/yiufung/beancount-hangseng/blob/master/config.py) for example)
2. Run `bean-extract config.py /path/to/eStatement.pdf > output.beancount`

### CSV

beancount-hangseng-csv -o output.csv -f {hangseng,mpower} /path/to/statement.pdf
beancount-hangseng-csv -o output.csv -f {hangseng,mpower,dbs} /path/to/statement.pdf

If statements are already downloaded in one folder, you may process and verify
output in one go:

cd /path/to/output_dir
beancount-hangseng-csv -t {hangseng, mpower} -v /path/to/HangSeng_*.pdf -d /tmp/
beancount-hangseng-csv -t {hangseng,mpower,dbs} -v /path/to/HangSeng_*.pdf -d /tmp/

Run `beancount-hangseng-csv -h` for more options and debug suggestions.

Expand Down

0 comments on commit 5e3eb73

Please sign in to comment.