Package correctly for pip

Author: Richard Pearce

.gitignore

@@ -1,2 +1,8 @@
-cache/
-examples/cache
+examples/cache
+timeguard-supportmaster/cache
+cache
+build
+dist
+tg
+__pycache__
+timeguard_supplymaster.egg-info/

README.md

@@ -21,25 +21,28 @@ The software is provided “as is”, without warranty of any kind, express or i
 1. Clone the repo
 
   ```bash
-  git clone git@github.com:rjpearce/timeguard-supplymaster-python.git timeguard
+  pip install timeguard-supplymaster
   ```
 
-1. Create ~/.timeguard.yaml
+2. Create ~/.timeguard.yaml
 
   ```bash
   ---
-  username: tg-username
-  password: tg-password
+  username: your-username
+  password: your-password
   use_cache: False
   ...
   ```
+
 ## Usage
 
 List all devices, programs and time slots.
 
 ```python
-tg = TimeGuard()
-tg.refresh_devices()
+from timeguard_supplymaster import Client
+
+client = Client()
+client.refresh_devices()
 for device in tg.devices:
   print(device.name, device.id)
   for program in device.programs:

examples/set_program.py

@@ -1,19 +1,18 @@
 
 import sys
-sys.path.append("..")
-from timeguard import TimeGuard
+from timeguard_supplymaster import Client
 
-tg = TimeGuard()
-tg.refresh_devices()
-for device in tg.devices:
+client = Client()
+client.refresh_devices()
+for device in client.devices:
   print(device.name, device.id)
   for program in device.programs:
     program.reset_all_time_slots()
     if program.id == '0':
-      program.time_slots[0].set_time(tg.EVERYDAY, '02:30', '03:00')
-      program.time_slots[1].set_time(tg.EVERYDAY, '03:00', '04:00')
-      program.time_slots[2].set_time(tg.EVERYDAY, '13:30', '14:00')
-      program.time_slots[3].set_time(tg.EVERYDAY, '14:30', '15:00')
+      program.time_slots[0].set_time(client.EVERYDAY, '02:30', '03:00')
+      program.time_slots[1].set_time(client.EVERYDAY, '03:00', '04:00')
+      program.time_slots[2].set_time(client.EVERYDAY, '13:30', '14:00')
+      program.time_slots[3].set_time(client.EVERYDAY, '14:30', '15:00')
       program.save()
     print(program.id, program.name)
     print(program.time_slots)

setup.py

@@ -0,0 +1,24 @@
+import setuptools
+
+with open("README.md", "r") as fh:
+    long_description = fh.read()
+
+setuptools.setup(
+    name="timeguard-supplymaster",
+    version="0.0.14",
+    author="Richard Pearce",
+    author_email="rjpearce23@gmail.com",
+    description="Implementation of the API used by the Timeguard's Supplymaster application",
+    long_description=long_description,
+    long_description_content_type="text/markdown",
+    url="https://github.com/rjpearce/timeguard-supplymaster-python",
+    packages=setuptools.find_packages(),
+    classifiers=[
+        "Development Status :: 3 - Alpha",
+        "Programming Language :: Python :: 3",
+        "License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)",
+        "Operating System :: OS Independent",
+        "Topic :: Home Automation",
+    ],
+    python_requires='>=3.6',
+)

timeguard.py

@@ -0,0 +1,4 @@
+from .client import Client
+from .device import Device
+from .program import Program
+from .timeslot import TimeSlot

timeguard_supplymaster/__init__.py

@@ -0,0 +1,76 @@
+import sys
+from pprint import pprint
+import os
+import requests
+from requests.auth import HTTPDigestAuth
+import yaml
+import json
+from pathlib import Path
+from .device import Device
+
+class Client:
+  """ Implements the TimeGuard Client """
+  config = {}
+  devices = []
+  connect_timeout = 10
+  read_timeout = 30
+  cache_folder = ''
+  base_url = ''
+  token = ''
+  user_id = ''
+  HEADERS = {'User-Agent': 'okhttp/3.3.1'}
+  BASE_URL = 'https://www.cloudwarm.net/TimeGuard/api/Android/v_1'
+  EVERYDAY = { 'Mon': True, 'Tue': True, 'Wed': True, 'Thu': True, 'Fri': True, 'Sat': True, 'Sun': True}
+
+  def __init__(self, config_path=f'{str(Path.home())}/.timeguard.yaml', cache_folder=f'{os.getcwd()}/cache'):
+    self.config = self.read_config(config_path)
+    self.validate_config()
+    self.cache_folder = cache_folder
+    os.makedirs(cache_folder, exist_ok=True)
+
+  def read_config(self, config_path):
+    """ Read the configuration file """
+    with open(config_path, 'r') as config_file:
+      return yaml.safe_load(config_file.read())
+
+  def validate_config(self):
+    """ Validate the config """
+    if 'username' not in self.config:
+      raise Exception('username missing from config')
+    if 'password' not in self.config:
+      raise Exception('password missing from config')
+    if 'use_cache' not in self.config:
+      self.config['use_cache'] = False
+
+  def api_request(self, type, uri, data=None):
+    response = None
+    cache_file = f'{uri.replace(self.token,"").replace("/","_")}.json'
+    if self.config['use_cache']:
+      with open(f'{self.cache_folder}/{cache_file}') as data_file:    
+        return json.load(data_file)
+    timeout = (self.connect_timeout, self.read_timeout)
+    if type == 'PUT':
+      print('PUT', f'{self.BASE_URL}/{uri}', data, self.HEADERS, timeout)
+      response = requests.put(f'{self.BASE_URL}/{uri}', data=data, headers=self.HEADERS, timeout=timeout)
+    elif type == 'GET':
+      print('GET', f'{self.BASE_URL}/{uri}', self.HEADERS, timeout)
+      response = requests.get(f'{self.BASE_URL}/{uri}', headers=self.HEADERS, timeout=timeout)
+    if response.status_code == 200:
+      print(response.status_code)
+      response_json = response.json()
+      pprint(response_json)
+      status_file = open(f'{self.cache_folder}/{cache_file}', 'w')
+      status_file.write(json.dumps(response_json))
+      status_file.close()
+      return response_json
+    else:
+      raise Exception(f'Login request failed: {response.status_code}')
+
+  def refresh_devices(self):
+    data = f'username={self.config["username"]}&password={self.config["password"]}'
+    response_json = self.api_request('PUT', 'users/login', data)
+    self.token = response_json['message']['user']['token']
+    self.user_id = response_json['message']['user']['id']
+    for device in response_json['message']['wifi_box']:
+      self.devices.append(Device(self, device))
+    return self.devices