Metadata-Version: 2.1
Name: aussiebb
Version: 0.2
Summary: A python library to interact with the Aussie Broadband customer portal
Home-page: https://www.madebymikal.com/aussiebb
Author: Michael Still
Author-email: mikal@stillhq.com
License: UNKNOWN
Description: What is this?
        =============
        
        This is a simple python API for the Aussie Broadband customer portal. There's
        a lot more that can be done with the portal than what I have implemented here,
        but this was enough to get me what I wanted for now (graphing for usage in
        prometheus and grafana).
        
        Feel free to drop me a line at mikal@stillhq.com if you want to help expand
        this.
        
        Installation
        ============
        
        You should run this in a venv. Do something like this:
        
        ```
        $ python3 -m venv ~/virtualenvs/aussiebb
        $ . ~/virtualenvs/aussiebb/bin/activate
        $ pip install -U pip
        $ pip install -U -r requirements.txt
        ```
        
        Usage
        =====
        
        A usage example in example.py, but here are the high points. First, install aussiebb from pypi:
        
        ```
        $ pip install aussiebb
        ```
        
        This code uses environment variables to get your username and password, so set those up:
        
        ```
        $ export AUSSIE_USERNAME="fred"
        $ export AUSSIE_PASSWORD="banana"
        ```
        
        Now run the example:
        
        ```
        $ python examples/example.py
        ```
        
        You should get output like this (for an example service of course):
        
        ```
        $ python3 example.py 
        You have 0 tickets open
        You have 2 orders
        
        +------+--------+---------------+--------------------+-------------+-----------------+--------------------+
        | Type |   ID   | Download (MB) |     Remaining      | Upload (MB) | Current Outages |      Bolt ons      |
        +------+--------+---------------+--------------------+-------------+-----------------+--------------------+
        | NBN  | 451493 |     450486    | Unlimited, 24 days |    22537    |        0        | Static IP ($10.00) |
        +------+--------+---------------+--------------------+-------------+-----------------+--------------------+
        ```
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
