Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mtlynch/beancount-chase-bank
Beancount importer for Chase bank
https://github.com/mtlynch/beancount-chase-bank
Last synced: about 1 month ago
JSON representation
Beancount importer for Chase bank
- Host: GitHub
- URL: https://github.com/mtlynch/beancount-chase-bank
- Owner: mtlynch
- License: mit
- Created: 2022-02-06T16:15:13.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2024-10-21T17:13:01.000Z (about 2 months ago)
- Last Synced: 2024-10-31T19:59:01.312Z (about 1 month ago)
- Language: Python
- Size: 186 KB
- Stars: 12
- Watchers: 2
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-beancount - Chase - installable) (Importers / US)
README
# beancount-chase-bank
[](https://pypi.org/project/beancount-chase-bank/)
[](https://circleci.com/gh/mtlynch/beancount-chase-bank)
[](LICENSE)
beancount-chase-bank provides an Importer for converting CSV exports Chase bank transactions into [Beancount](https://github.com/beancount/beancount) v2 format.
## Installation
```bash
pip install beancount-chase-bank
```
## Usage
### Checking Accounts
Add the Chase Checking importer to your account as follows:
```python
import beancount_chase
CONFIG = [
beancount_chase.CheckingImporter(
'Assets:Checking:Chase',
currency='USD',
lastfour='1234', # Replace with last four digits of your account
account_patterns=[
# These are example patterns. You can add your own.
('GITHUB', 'Expenses:Cloud-Services:Source-Hosting:Github'),
('Fedex', 'Expenses:Postage:FedEx'),
]
),
]
```
Once this configuration is in place, you can use `bean-extract` to convert a Chase CSV export of transactions to beancount format:
```bash
bean-extract config.py Chase1234_Activity_20220219.CSV
```
### Credit Cards
Add the Chase Credit card importer to your account as follows:
```python
import beancount_chase
CONFIG = [
beancount_chase.CreditImporter(
'Liabilities:Credit-Cards:Chase',
currency='USD',
lastfour='1234', # Replace with last four digits of your account
account_patterns=[
# These are example patterns. You can add your own.
('GITHUB', 'Expenses:Cloud-Services:Source-Hosting:Github'),
('Fedex', 'Expenses:Postage:FedEx'),
]
),
]
```
Once this configuration is in place, you can use `bean-extract` to convert a Chase CSV export of transactions to beancount format:
```bash
bean-extract config.py Chase1234_Activity20210808_20210907_20210929.CSV
```
## API
### `account_patterns`
The `account_patterns` parameter is a list of (regex, account) pairs. For each line in your CSV, the Chase importer will attempt to create a matching posting on the transaction by matching the payee, narration, or the concatenated pair to the regexes.
The regexes are in priority order, with earlier patterns taking priority over later patterns.
## Resources
See [awesome-beancount](https://awesome-beancount.com/) for other publicly available Beancount importers.