Metadata-Version: 2.1
Name: ausfin
Version: 0.1.1
Summary: Account balance scraping for Australian financial institutions
Home-page: https://github.com/cmbrad/ausfin-scrape
Author: Chris Braldey
Author-email: chris.bradley@cy.id.au
License: UNKNOWN
Description: # Australian Finance Scrapers
        
        This repository provides a number of scrapers which connect to various Australian financial
        institutions to get the current account balance. Available scrapers are:
        
        * 28 Degrees
        * Acorns
        * BTCMarkets
        * Commbank (Bank)
        * Commbank (Shares)
        * ING Direct
        * Ratesetter
        * Suncorp Bank (Bank)
        * Suncorp Bank (Shares)
        * Ubank
        * Unisuper
        
        ## Prerequisites
        * Python 3.6
        * Google Chrome
        
        ## Installation
        
        1. Install Chrome Driver (https://github.com/SeleniumHQ/selenium/wiki/ChromeDriver)
        2. Install this package with `pip install -e .`
        
        ## Usage
        ### Balance
        Run as follows:
        
        ```bash
        ausfin balance [source] -u [username] -p [password]
        ```
        
        eg.
        
        ```bash
        ausfin balance acorns -u username -p password
        ```
        
        Source must be one of:
        * 28degrees-credit
        * acorns-investment
        * btcmarkets-investment
        * commbank-bank
        * commbank-investment
        * ing-bank
        * ratesetter-investment
        * suncorpbank-bank
        * suncorpbank-super
        * ubank-bank
        * unisuper-super
        
        ### Net Worth
        
        Save a config file in the format, for example as `config.json`:
        
        ```json
        {
          "accounts": [
            {
              "source": "28degrees-credit",
              "username": "ausername",
              "password": "apassword"
            },
            {
              "source": "anothersource",
              "username": "adifferentusername",
              "password": "adifferentpassword"
            }
          ]
        }
        ```
        
        Then:
        
        ```bash
        ausfin net-worth -c config.json
        ```
        
Platform: UNKNOWN
Description-Content-Type: text/markdown
Provides-Extra: test
