Metadata-Version: 2.1
Name: aib2ofx
Version: 0.70.0a1
Summary: Download data from aib.ie in OFX format
Home-page: https://github.com/yacoob/aib2ofx
License: MIT
Author: Jakub Turski
Author-email: yacoob@gmail.com
Requires-Python: >=3.7,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Dist: mechanicalsoup (>=0.12,<0.13)
Requires-Dist: python-dateutil (>=2.8.1,<3.0.0)
Project-URL: Repository, https://github.com/yacoob/aib2ofx
Description-Content-Type: text/markdown

# aib2ofx

...or how to grab transaction data out of AIB's online interface, and format it
into `OFX` file.

## Installation

    python3 -mvenv aib2ofx
    pip install aib2ofx

This will create a virtualenv for `aib2ofx`, fetch its code then install it with
all dependencies. Once that completes, you'll find `aib2ofx` executable in the
`bin` directory of this new virtualenv.

## Usage

Create a `~/.aib2ofx.json` file, with AIB login details.
Set the permission bits to 0600 to prevent other system users from reading it.

    touch ~/.aib2ofx.json
    chmod 0600 ~/.aib2ofx.json

It has a JSON format, single object with one key per AIB login you want to use.

    {
        "bradmajors": {
            "regNumber": "12345678",
            "pin": "12345"
        }
    }

The fields are as follows:

* regNumber
    > Your AIB registered number.

* pin
    > Your five digit PIN.

You can put more than one set of credentials in the file; the script
will download data for all accounts for all logins.

    {
        "bradmajors": {
            "regNumber": "12345678",
            "pin": "12345"
        },
        "janetweiss": {
            "regNumber": "87654321",
            "pin": "54321"
        }
    }

Note that there's no comma after the last account details.

Once you've prepared that config file, run:

    aib2ofx -d /output/directory

The script should connect to AIB, log in using provided credentials,
iterate through all accounts, and save each of those to a separate
file located in `/output/directory`.

## Guarantee

There is none.

I've written that script with my best intentions, it's not malicious,
it's not sending the data anywhere, it's not doing anything nasty. I'm
using it day to day to get data about my AIB accounts into a financial
program that I use. It should work for you as good as it works for
me. See the `LICENSE` file for more details.

