diff --git a/README.md b/README.md index e7ca9d7..abb5b16 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,52 @@ -UPLINK 0.1 ----------- \ No newline at end of file +# UPLINK 0.1 + +TODO: Write description. + +## Requirements + + - Python 3.8 + - fritzconnection 1.3.4 (pip install fritzconnection) + - https://pypi.org/project/fritzconnection/ + - https://fritzconnection.readthedocs.io/en/1.3.4/index.html + +## Installation + + git clone https://git.unixpeople.org/hanez/uplink.git + cd uplink + cp config.example.json config.json + +### Configuration + +Edit config.json to your needs. + +#### Variables + + - interval: The polling interval + - database: Path to sqlite3 Database + - uplinks: List of devices you want to poll + - provider: Custom name of the uplink provider + - ip: The IP of the router device + - password: The password of the router device + +#### Example + + { + "interval": 60, + "database": "./uplink.sqlite3", + "uplinks": [ + { "provider": "Cable Provider", "ip": "192.168.0.1", "password": "1234" }, + { "provider": "DSL Provider", "ip": "192.168.1.1", "password": "1234" } + ] + } + +### Create Database + + sqlite3 uplink.sqlite3 < uplink.sql + +## Usage + + ./uplink ./config.json + +### Help + + ./uplink --help \ No newline at end of file diff --git a/uplink.py b/uplink similarity index 99% rename from uplink.py rename to uplink index 8e5549c..c793079 100755 --- a/uplink.py +++ b/uplink @@ -31,7 +31,6 @@ import os import os.path as path import sqlite3 import time -# import tzlocal from fritzconnection.lib.fritzstatus import FritzStatus