corriander / aachaos

Utility for fetching information from the A&A ISP API (https://chaos.aa.net.uk)

aachaos

Simple utility for pulling down Andrew & Arnolds ISP line info from their Chaos API.

This is geared towards a simple Home::1 service configuration (100/200 GB, single line) and a mini-project for my own purposes (inc. a sandpit for trying out some new things); no guarantees about functionality or completeness!

Credit for some inspiration for implementing as a webapp from here as linked to by A&A.

Install

This is a very rough guide, proper installation hasn't been implemented.

cp config/config.ini ~/.config/aachaos/ # Config file
cp bin/* ~/.local/bin/					# Sample scripts

Specify paths for database, figure, etc. in config.ini and use config/cron as a template for the user cron. Put A&A user credentials in ~/.config/aachaos/auth (chmod 600) in the following format:

user:password

A database will be created at the location specified in the config file on the first update.

Usage

Execute in the project directory via:

python3 -m aachaos.main

Run tests in the project directory with:

python3 -m unittest discover

TODO

• Shift database interface into new db.py so the following architecture can be implemented cleanly:

  		       +-----+          +-----+
  		       |     |          | API |
  		       | DB  |          |     |
  		       +-+-^-+          +--+--+
  		         | |               |
  		         | |               |
  		+--------v-+----------+    |
  		|     db interface    |    |
  		+----+-------------^--+    |
  		     |             |       |
  		     |             |       |
  		     |       +-----+--+    |
  		     |       | store  |    |
  		     |       +-----^--+    |
  		     |             |       |
  		     |             |       |
  		+----v-------------+-------v-----+
  		|             get                |
  		+----+-------------+-------^-----+
  		     |             |       |
  			 |             |       |
  		+----v----+        |       |
  gfx	<---|   vis   |        |       |
  		+----+----+        |       |
  		     |             |       |
  			 |             |       |
  		+----v-------------v-------+-----+
  		|             main               |
  		+--------------------------------+
  

  It's similar now, but with store providing the database interface. This is sufficient but not quite as semantically tight.

• We should generate the visualisation when fetching from the API as there's no point doing it at other times (or, alternatively, only generate it if it hasn't been generated since the last fetch... maybe less intensive on the server).

• Dependencies

• Install / package

• Proper entry point (refactor main slightly).