Merge pull request #1 from acoster/devel

Sync main to version 0.1.0

Author: acoster

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Alex Coster
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,4 +1,42 @@
 # busytag_tool
 
-Python library (and soon CLI) to interact with [Busy Tag](https://www.busy-tag.com/) devices via USB,
-using its [USB CDC interface]( https://luxafor.helpscoutdocs.com/article/47-busy-tag-usb-cdc-command-reference-guide).
+Python library and CLI to interact with [Busy Tag](https://www.busy-tag.com/) devices using
+the [USB CDC interface]( https://luxafor.helpscoutdocs.com/article/47-busy-tag-usb-cdc-command-reference-guide).
+
+## Installation
+
+```shell
+$ pip install busytag
+```
+
+## CLI usage
+
+The first time the tool is used, you should pass the device path through
+the flag `--device=/dev/whatever`. This will be saved in `~/.busytag.toml`
+and will be used in subsequent runs where `--device` is not passed.
+
+```shell
+$ busytag-tool 
+Available commands:
+  help: Prints this message
+  info: Displays device information
+  list_pictures: Lists pictures in device
+  list_files: Lists files in device
+  get_picture: Gets the filename of the picture being shown
+  set_picture <filename>: Sets the picture shown in the device
+  put <filename>: Uploads <filename>
+  get <filename>: Copies <filename> from the device to the working directory
+  rm <filename>: Deletes <filename>
+  set_led_solid_color <6 hex RGB colour>: Sets the LEDs colour
+  get_brightness: Gets current display brightness
+  set_brightness <brightness>: Sets current display brightness (int between 1 and 100, inclusive
+```
+
+## API usage
+
+```python
+from busytag import Device
+
+bt = Device('/dev/fooBar')
+bt.set_active_picture('coding.gif')
+```

pyproject.toml

@@ -0,0 +1,30 @@
+[project]
+name = "busytag"
+version = "0.1.0"
+dynamic = ["dependencies"]
+authors = [{ name = "Alex Coster", email = "[email protected]" }]
+description = "A library and CLI tool to control Busy Tag devices."
+readme = "README.md"
+requires-python = ">=3.11"
+license = "MIT"
+license-files = ["LICENSE"]
+classifiers = [
+    "Development Status :: 2 - Pre-Alpha",
+    "Environment :: Console",
+    "Operating System :: OS Independent"
+]
+
+[project.scripts]
+busytag-tool = "busytag.tool:run_main"
+
+[project.urls]
+Homepage = "https://github.com/acoster/busytag_tool"
+Issues = "https://github.com/acoster/busytag_tool/issues"
+Repository = "https://github.com/acoster/busytag_tool.git"
+
+[build-system]
+requires = ["hatchling >= 1.26", "hatch-requirements-txt"]
+build-backend = "hatchling.build"
+
+[tool.hatch.metadata.hooks.requirements_txt]
+files = ["requirements.txt"]

requirements.txt

@@ -1,2 +1,4 @@
 -i https://pypi.org/simple
-pyserial~=3.5
+absl-py~=2.1.0
+pyserial~=3.5
+tomlkit~=0.13.2

src/busytag/__init__.py

@@ -0,0 +1,4 @@
+# SPDX-License-Identifier: MIT
+
+from .device import Device
+from .types import *

src/busytag/config.py

@@ -0,0 +1,31 @@
+# SPDX-License-Identifier: MIT
+
+import tomlkit
+import os.path
+
+from .types import *
+
+from typing import Optional, Sequence
+
+class ToolConfig(object):
+    def __init__(self, path: Optional[str] = None):
+        self.device = None
+        self.path = path
+        if path is not None:
+            self.path = os.path.expanduser(path)
+            if os.path.exists(self.path):
+                self.__load_from_file()
+
+
+    def write_to_file(self):
+        assert self.path is not None
+        conf = {}
+        if self.device is not None:
+            conf['device'] = self.device
+        with open(self.path, "w") as fp:
+            tomlkit.dump(conf, fp)
+
+    def __load_from_file(self):
+        with open(self.path, 'rb') as fp:
+            conf = tomlkit.load(fp)
+            self.device = conf['device']