beancount-chase-bank


Namebeancount-chase-bank JSON
Version 0.2.3 PyPI version JSON
download
home_pagehttps://github.com/mtlynch/beancount-chase.git
SummaryImport Chase banking transactions into beancount format
upload_time2024-01-04 23:38:06
maintainer
docs_urlNone
authorMichael Lynch
requires_python>=3.9
licenseMIT
keywords chase beancount bookkeeping finance
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # beancount-chase-bank

[![PyPI](https://img.shields.io/pypi/v/beancount-chase-bank)](https://pypi.org/project/beancount-chase-bank/)
[![CircleCI](https://circleci.com/gh/mtlynch/beancount-chase-bank.svg?style=svg)](https://circleci.com/gh/mtlynch/beancount-chase-bank)
[![License](http://img.shields.io/:license-mit-blue.svg?style=flat-square)](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.



            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/mtlynch/beancount-chase.git",
    "name": "beancount-chase-bank",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": "",
    "keywords": "chase beancount bookkeeping finance",
    "author": "Michael Lynch",
    "author_email": "",
    "download_url": "https://files.pythonhosted.org/packages/e5/7b/a85d0ca2e28aa2916eb9509c6cb9d1b161fb95418c91b227e66d8ed9d076/beancount-chase-bank-0.2.3.tar.gz",
    "platform": null,
    "description": "# beancount-chase-bank\n\n[![PyPI](https://img.shields.io/pypi/v/beancount-chase-bank)](https://pypi.org/project/beancount-chase-bank/)\n[![CircleCI](https://circleci.com/gh/mtlynch/beancount-chase-bank.svg?style=svg)](https://circleci.com/gh/mtlynch/beancount-chase-bank)\n[![License](http://img.shields.io/:license-mit-blue.svg?style=flat-square)](LICENSE)\n\nbeancount-chase-bank provides an Importer for converting CSV exports Chase bank transactions into [Beancount](https://github.com/beancount/beancount) v2 format.\n\n## Installation\n\n```bash\npip install beancount-chase-bank\n```\n\n## Usage\n\n### Checking Accounts\n\nAdd the Chase Checking importer to your account as follows:\n\n```python\nimport beancount_chase\n\nCONFIG = [\n    beancount_chase.CheckingImporter(\n        'Assets:Checking:Chase',\n        currency='USD',\n        lastfour='1234', # Replace with last four digits of your account\n        account_patterns=[\n          # These are example patterns. You can add your own.\n          ('GITHUB', 'Expenses:Cloud-Services:Source-Hosting:Github'),\n          ('Fedex',  'Expenses:Postage:FedEx'),\n        ]\n    ),\n]\n```\n\nOnce this configuration is in place, you can use `bean-extract` to convert a Chase CSV export of transactions to beancount format:\n\n```bash\nbean-extract config.py Chase1234_Activity_20220219.CSV\n```\n\n### Credit Cards\n\nAdd the Chase Credit card importer to your account as follows:\n\n```python\nimport beancount_chase\n\nCONFIG = [\n    beancount_chase.CreditImporter(\n        'Liabilities:Credit-Cards:Chase',\n        currency='USD',\n        lastfour='1234', # Replace with last four digits of your account\n        account_patterns=[\n          # These are example patterns. You can add your own.\n          ('GITHUB', 'Expenses:Cloud-Services:Source-Hosting:Github'),\n          ('Fedex',  'Expenses:Postage:FedEx'),\n        ]\n    ),\n]\n```\nOnce this configuration is in place, you can use `bean-extract` to convert a Chase CSV export of transactions to beancount format:\n\n```bash\nbean-extract config.py Chase1234_Activity20210808_20210907_20210929.CSV\n```\n\n## API\n\n### `account_patterns`\n\nThe `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.\n\nThe regexes are in priority order, with earlier patterns taking priority over later patterns.\n\n## Resources\n\nSee [awesome-beancount](https://awesome-beancount.com/) for other publicly available Beancount importers.\n\n\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Import Chase banking transactions into beancount format",
    "version": "0.2.3",
    "project_urls": {
        "Homepage": "https://github.com/mtlynch/beancount-chase.git"
    },
    "split_keywords": [
        "chase",
        "beancount",
        "bookkeeping",
        "finance"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "b3fdd6667867b12dbb06dc7b176a6b865a51c5d2c5855c63915e6757fea60d76",
                "md5": "93e310408a21408af5349bd8bccd92cc",
                "sha256": "5f3a3acfd158e6cd22e65e959860c45affd1b10c5f395fc5cd8b3614f5c2b5ea"
            },
            "downloads": -1,
            "filename": "beancount_chase_bank-0.2.3-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "93e310408a21408af5349bd8bccd92cc",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 8698,
            "upload_time": "2024-01-04T23:38:05",
            "upload_time_iso_8601": "2024-01-04T23:38:05.274006Z",
            "url": "https://files.pythonhosted.org/packages/b3/fd/d6667867b12dbb06dc7b176a6b865a51c5d2c5855c63915e6757fea60d76/beancount_chase_bank-0.2.3-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "e57ba85d0ca2e28aa2916eb9509c6cb9d1b161fb95418c91b227e66d8ed9d076",
                "md5": "a53e6c0f09c01c46809410706d747e4b",
                "sha256": "d788b11e7bf6b708ad3570bdb01f0b38c5cfac1dd7dd84fa47aabbcb148101a0"
            },
            "downloads": -1,
            "filename": "beancount-chase-bank-0.2.3.tar.gz",
            "has_sig": false,
            "md5_digest": "a53e6c0f09c01c46809410706d747e4b",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 6518,
            "upload_time": "2024-01-04T23:38:06",
            "upload_time_iso_8601": "2024-01-04T23:38:06.390799Z",
            "url": "https://files.pythonhosted.org/packages/e5/7b/a85d0ca2e28aa2916eb9509c6cb9d1b161fb95418c91b227e66d8ed9d076/beancount-chase-bank-0.2.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-01-04 23:38:06",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "mtlynch",
    "github_project": "beancount-chase",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "circle": true,
    "requirements": [],
    "lcname": "beancount-chase-bank"
}
        
Elapsed time: 0.16991s