Skip to content
A python API for the Aussie Broadband customer portal
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
aussiebb
examples Improved readme, a helper method, and release 0.2. Jun 20, 2019
.gitignore Initial commit Jun 20, 2019
LICENSE Initial commit Jun 20, 2019
README.md Improved readme, a helper method, and release 0.2. Jun 20, 2019
requirements.txt
setup.py

README.md

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) |
+------+--------+---------------+--------------------+-------------+-----------------+--------------------+
You can’t perform that action at this time.