Format as a package ready for upload to PyPi

Author: rhyst

.gitignore

@@ -1,6 +1,8 @@
 ref/
 venv/
-config.yaml
 .vscode
 desk.pickle
 __pycache__/
+*.egg-info
+dist/
+build/

README.md

@@ -10,15 +10,15 @@ The desk should be connected and paired to the computer.
 
 ### Install
 
-Install the Python requirements found in `requirements.txt`:
+Install using pip:
 
 ```
-pip install -r requirements.txt
+pip install idasen-controller
 ```
 
 ### Configuration
 
-Configuration can either be provided with a file, or via command line arguments. Use `--help` to see the command line arguments help. Edit `config.yaml` if you prefer your config to be in a file.
+Configuration can either be provided with a file, or via command line arguments. Use `--help` to see the command line arguments help. Edit `<config_dir>/config.yaml` if you prefer your config to be in a file. `<config_dir>` is normally `~/.config/idasen-controller` on Linux and `C:\Users\<user>\AppData\Local\idasen-controller\idasen-controller` on Windows.
 
 Config options:
 
@@ -30,10 +30,8 @@ Config options:
 - `scan_timeout` - Timeout to scan for the device (seconds). Default `5`
 - `connection_timeout` - Timeout to obtain connection (seconds). Default `10`
 - `movement_timeout` - Timeout for waiting for the desk to reach the specified height (seconds). Default `30`
-- `forward` - Forward commands to a script running as a server.
-- `server` - Run this script as a server to accept forwarded commands.
-- `server_address` - The address the server should run at. Default `127.0.0.1`
-- `server_port` - The port the server should run on. Default `9123`
+- `server_address` - The address the server should run at (if running server). Default `127.0.0.1`
+- `server_port` - The port the server should run on (if running server). Default `9123`
 
 Device MAC addresses can be found using `bluetoothctl` and blueooth adapter names can be found with `hcitool dev` on linux, and on Windows you can use [Bluetooth LE Explorer](https://www.microsoft.com/en-us/p/bluetooth-le-explorer/9n0ztkf1qd98?activetab=pivot:overviewtab).
 
@@ -44,55 +42,79 @@ Device MAC addresses can be found using `bluetoothctl` and blueooth adapter name
 To print the current desk height:
 
 ```
-python3 main.py
+idasen-controller
 ```
 
 To monitor for changes to height (and speed):
 
 ```
-python3 main.py --monitor
+idasen-controller --monitor
 ```
 
 Assuming the config file is populated to move the desk to standing position:
 
 ```
-python3 main.py --stand
+idasen-controller --stand
 ```
 
 Assuming the config file is populated to move the desk to sitting position:
 
 ```
-python3 main.py --sit
+idasen-controller --sit
 ```
 
 Move the desk to a certain height (mm) above the floor:
 
 ```
-python3 main.py --move-to 800
+idasen-controller --move-to 800
 ```
 
 Listing available bluetooth devices (using the configured `adapter_name`):
 
 ```
-python main.py --scan
+idasen-controller --scan
 ```
 
 To run the script as a server, which will maintain the connection and provide quicker response times:
 
 ```
-python main.py --server
+idasen-controller --server
 ```
 
 And to send commands to the server add the forward argument:
 
 ```
-python main.py --forward --stand
+idasen-controller --forward --stand
+```
+
+To specify a path to a config file:
+
+```
+idasen-controller --config <path>
 ```
 
+### Connection times
+
+On Linux the script is able to cache the connection details so after the first connection subsequent commands should be very quick. On Windows this is not possible and so the script must scan for and connect to the desk every time a command is sent. One option is to reduce the `scan_timeout`. I have found that it can work well set to just `1` second. Also the server mode is intended as another workaround for this. Run the script once with `--server` which will start a persistent server and maintain a connection to the desk. Then when sending commands (like `--stand` or `--sit`) just add the additional argument `--forward` to forward the command to the server. The server should already have a connection so the desk should respond much quicker.
+
 ## Recipes
 
 There is a page with a few examples of different ways to use the script: [RECIPES](RECIPES.md)
 
+## Development
+
+To run the script without installing via pip first install the requirements:
+
+```
+pip install -r requirements.txt
+```
+
+Then you can run all the same commands with:
+
+```
+python idasen_controller/main.py <command>
+```
+
 ## Desk Internals
 
 ### Connection and Commands

idasen_controller/__init__.py

@@ -1,5 +1,6 @@
 #!python3
 import os
+import shutil
 import struct
 import argparse
 import yaml
@@ -8,6 +9,7 @@
 import pickle
 import json
 import functools
+from appdirs import user_config_dir
 
 IS_LINUX = os.name == 'posix'
 IS_WINDOWS = os.name == 'nt'
@@ -38,8 +40,9 @@ def rawToSpeed(raw):
 COMMAND_REFERENCE_INPUT_DOWN = bytearray(struct.pack("<H", 32767))
 
 # OTHER DEFINITIONS
-
-PICKLE_FILE = os.path.join(os.path.dirname(os.path.abspath(__file__)), 'desk.pickle')
+DEFAULT_CONFIG_DIR = user_config_dir('idasen-controller')
+DEFAULT_CONFIG_PATH = os.path.join(DEFAULT_CONFIG_DIR, 'config.yaml')
+PICKLE_FILE = os.path.join(DEFAULT_CONFIG_DIR, 'desk.pickle')
 
 # CONFIGURATION SETUP
 
@@ -49,6 +52,10 @@ def rawToSpeed(raw):
 MAX_HEIGHT = 1270  # 6500
 
 # Default config
+if not os.path.isfile(DEFAULT_CONFIG_PATH):
+    os.makedirs(os.path.dirname(DEFAULT_CONFIG_PATH), exist_ok=True)
+    shutil.copyfile(os.path.join(os.path.dirname(__file__), 'example', 'config.yaml'), DEFAULT_CONFIG_PATH)
+
 config = {
     "mac_address": None,
     "stand_height": BASE_HEIGHT + 420,
@@ -66,20 +73,6 @@ def rawToSpeed(raw):
     "server_port": 9123
 }
 
-# Overwrite from config.yaml
-config_file = {}
-config_file_path = os.path.join(os.path.dirname(
-    os.path.realpath(__file__)), 'config.yaml')
-if (config_file_path):
-    with open(config_file_path, 'r') as stream:
-        try:
-            config_file = yaml.safe_load(stream)
-        except yaml.YAMLError as exc:
-            print("Reading config.yaml failed")
-            exit(1)
-config.update(config_file)
-
-# Overwrite from command line args
 parser = argparse.ArgumentParser(description='')
 parser.add_argument('--mac-address', dest='mac_address',
                     type=str, help="Mac address of the Idasen desk")
@@ -103,6 +96,8 @@ def rawToSpeed(raw):
                  help="The address the server should run at")
 parser.add_argument('--server_port', dest='server_port', type=int,
                  help="The port the server should run on")
+parser.add_argument('--config', dest='config', type=str,
+                 help="File path to the config file (Default: {})".format(DEFAULT_CONFIG_PATH), default=DEFAULT_CONFIG_PATH)
 cmd = parser.add_mutually_exclusive_group()
 cmd.add_argument('--sit', dest='sit', action='store_true',
                  help="Move the desk to sitting height")
@@ -117,8 +112,23 @@ def rawToSpeed(raw):
 cmd.add_argument('--server', dest='server', action='store_true',
                  help="Run as a server to accept forwarded commands")
 
-
 args = {k: v for k, v in vars(parser.parse_args()).items() if v is not None}
+
+# Overwrite config from config.yaml
+config_file = {}
+config_file_path = os.path.join(args['config'])
+if (config_file_path and os.path.isfile(config_file_path)):
+    with open(config_file_path, 'r') as stream:
+        try:
+            config_file = yaml.safe_load(stream)
+        except yaml.YAMLError as exc:
+            print("Reading config.yaml failed")
+            exit(1)
+else:
+    print('No config file found')
+config.update(config_file)
+
+# Overwrite config from command line args
 config.update(args)
 
 if not config['mac_address']:
@@ -388,8 +398,11 @@ async def main():
             await disconnect(client)
             print('Disconnected         ')
 
-if __name__ == "__main__":
+def init():
     try:
         asyncio.run(main())
     except KeyboardInterrupt:
-        pass
+        pass
+
+if __name__ == "__main__":
+    init()

config-example.yaml idasen_controller/example/config.yaml

@@ -1,3 +1,4 @@
+appdirs==1.4.4
 attrs==20.3.0
 Automat==20.2.0
 bleak==0.10.0

main.py idasen_controller/main.py

@@ -0,0 +1,37 @@
+from os import path
+from setuptools import setup, find_packages 
+  
+with open('requirements.txt') as f: 
+    requirements = f.readlines() 
+  
+this_directory = path.abspath(path.dirname(__file__))
+with open(path.join(this_directory, 'README.md')) as f:
+    long_description = f.read()
+  
+setup( 
+        name ='idasen-controller', 
+        version ='1.0.0', 
+        author ='Rhys Tyers', 
+        author_email ='', 
+        url ='https://github.com/rhyst/idasen-controller', 
+        description ='Command line tool for controlling the Ikea Idasen (Linak) standing desk', 
+        long_description = long_description, 
+        long_description_content_type ="text/markdown", 
+        license ='MIT', 
+        packages = find_packages(), 
+        entry_points ={ 
+            'console_scripts': [ 
+                'idasen-controller=idasen_controller.main:init'
+            ] 
+        }, 
+        classifiers =( 
+            "Programming Language :: Python :: 3", 
+            "License :: OSI Approved :: MIT License", 
+            "Operating System :: OS Independent", 
+        ), 
+        keywords ='python package idasen-controller idasen linak standing desk', 
+        install_requires = requirements, 
+        zip_safe = False,
+        include_package_data = True,
+        package_data={'': ['example/*']},
+)