truffile 0.0.0__tar.gz

truffile-0.0.0/PKG-INFO

@@ -0,0 +1,125 @@
+Metadata-Version: 2.4
+Name: truffile
+Version: 0.0.0
+Summary: truffile the TruffleOS SDK - Connect and deploy apps to Truffle devices
+License: MIT
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+Requires-Dist: grpcio>=1.60.0
+Requires-Dist: protobuf>=4.25.0
+Requires-Dist: httpx>=0.27.0
+Requires-Dist: pyyaml>=6.0
+Requires-Dist: platformdirs>=3.10.0
+Requires-Dist: websockets>=12.0
+Requires-Dist: zeroconf>=0.131.0
+Provides-Extra: dev
+Requires-Dist: pytest>=8.0.0; extra == "dev"
+Requires-Dist: grpcio-tools>=1.60.0; extra == "dev"
+
+# truffile
+
+TruffleOS SDK - deploy apps to Truffle devices
+
+## install
+
+```bash
+pip install truffile
+```
+
+or from source:
+```bash
+git clone <repo>
+cd truffile
+pip install -e .
+```
+
+## commands
+
+```bash
+# find truffle devices on your network
+truffile scan
+
+# connect to a device (first time requires approval on device)
+truffile connect truffle-6272
+
+# deploy an app from current directory
+truffile deploy
+
+# deploy an app from a specific path
+truffile deploy ./my-app
+
+# deploy with interactive shell (for debugging)
+truffile deploy -i
+
+# list installed apps on connected device
+truffile list apps
+
+# list connected devices
+truffile list devices
+
+# disconnect from a device
+truffile disconnect truffle-6272
+
+# disconnect from all devices
+truffile disconnect all
+```
+
+## truffile.yaml
+
+apps need a `truffile.yaml` in their directory:
+
+```yaml
+metadata:
+  name: My App
+  description: does cool stuff
+  type: background  # or foreground
+  icon_file: ./icon.png
+  process:
+    cmd: [python, app.py]
+    working_directory: /
+    environment:
+      MY_VAR: value
+  # schedule for background apps only:
+  default_schedule:
+    type: interval  # interval | times
+    interval:
+      duration: "1h"  # 15m, 2h, 1d, etc.
+      schedule:
+        daily_window: "09:00-17:30"  # optional
+        allowed_days: [mon, tue, wed, thu, fri]  # optional
+
+files:
+  - source: ./app.py
+    destination: ./app.py
+
+run: |
+  pip install requests
+```
+
+### schedule types
+
+**interval** - run every N minutes/hours:
+```yaml
+default_schedule:
+  type: interval
+  interval:
+    duration: "30m"
+    schedule:
+      daily_window: "06:00-22:00"
+      allowed_days: [mon, tue, wed, thu, fri]
+```
+
+**times** - run at specific times:
+```yaml
+default_schedule:
+  type: times
+  times:
+    run_times: ["08:00", "12:00", "18:00"]
+    allowed_days: [mon, tue, wed, thu, fri]
+```
+
+## example apps
+
+see `example-apps/` for working examples:
+- `example-apps/ambient/hedge` - background app
+- `example-apps/focus/finance` - foreground app

truffile-0.0.0/README.md

@@ -0,0 +1,107 @@
+# truffile
+
+TruffleOS SDK - deploy apps to Truffle devices
+
+## install
+
+```bash
+pip install truffile
+```
+
+or from source:
+```bash
+git clone <repo>
+cd truffile
+pip install -e .
+```
+
+## commands
+
+```bash
+# find truffle devices on your network
+truffile scan
+
+# connect to a device (first time requires approval on device)
+truffile connect truffle-6272
+
+# deploy an app from current directory
+truffile deploy
+
+# deploy an app from a specific path
+truffile deploy ./my-app
+
+# deploy with interactive shell (for debugging)
+truffile deploy -i
+
+# list installed apps on connected device
+truffile list apps
+
+# list connected devices
+truffile list devices
+
+# disconnect from a device
+truffile disconnect truffle-6272
+
+# disconnect from all devices
+truffile disconnect all
+```
+
+## truffile.yaml
+
+apps need a `truffile.yaml` in their directory:
+
+```yaml
+metadata:
+  name: My App
+  description: does cool stuff
+  type: background  # or foreground
+  icon_file: ./icon.png
+  process:
+    cmd: [python, app.py]
+    working_directory: /
+    environment:
+      MY_VAR: value
+  # schedule for background apps only:
+  default_schedule:
+    type: interval  # interval | times
+    interval:
+      duration: "1h"  # 15m, 2h, 1d, etc.
+      schedule:
+        daily_window: "09:00-17:30"  # optional
+        allowed_days: [mon, tue, wed, thu, fri]  # optional
+
+files:
+  - source: ./app.py
+    destination: ./app.py
+
+run: |
+  pip install requests
+```
+
+### schedule types
+
+**interval** - run every N minutes/hours:
+```yaml
+default_schedule:
+  type: interval
+  interval:
+    duration: "30m"
+    schedule:
+      daily_window: "06:00-22:00"
+      allowed_days: [mon, tue, wed, thu, fri]
+```
+
+**times** - run at specific times:
+```yaml
+default_schedule:
+  type: times
+  times:
+    run_times: ["08:00", "12:00", "18:00"]
+    allowed_days: [mon, tue, wed, thu, fri]
+```
+
+## example apps
+
+see `example-apps/` for working examples:
+- `example-apps/ambient/hedge` - background app
+- `example-apps/focus/finance` - foreground app

truffile-0.0.0/pyproject.toml

@@ -0,0 +1,44 @@
+[build-system]
+requires = ["setuptools>=61.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools_scm]
+version_scheme = "guess-next-dev"
+local_scheme = "no-local-version"
+fallback_version = "0.1.dev0"
+version_file = "truffile/_version.py"
+
+[project]
+name = "truffile"
+dynamic = ["version"]
+description = "truffile the TruffleOS SDK - Connect and deploy apps to Truffle devices"
+readme = "README.md"
+requires-python = ">=3.10"
+license = {text = "MIT"}
+
+dependencies = [
+    "grpcio>=1.60.0",
+    "protobuf>=4.25.0",
+    "httpx>=0.27.0",
+    "pyyaml>=6.0",
+    "platformdirs>=3.10.0",
+    "websockets>=12.0",
+    "zeroconf>=0.131.0",
+]
+
+[project.scripts]
+truffile = "truffile.cli:main"
+truffleinferproxy = "truffile.infer.proxy:main"
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=8.0.0",
+    "grpcio-tools>=1.60.0",
+]
+
+[tool.setuptools.packages.find]
+where = ["."]
+include = ["truffile*", "truffle*"]
+
+[tool.setuptools.package-data]
+"*" = ["*.pyi", "py.typed"]

truffile-0.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

truffile-0.0.0/truffile/__init__.py

@@ -0,0 +1,19 @@
+try:
+    from ._version import __version__
+except ImportError:
+    __version__ = "0.1.dev0"
+
+from .client import TruffleClient, ExecResult, UploadResult, resolve_mdns, NewSessionStatus
+from .schedule import parse_runtime_policy
+from truffle.app.app_type_pb2 import AppType
+
+__all__ = [
+    "__version__",
+    "TruffleClient",
+    "ExecResult",
+    "UploadResult",
+    "resolve_mdns",
+    "NewSessionStatus",
+    "AppType",
+    "parse_runtime_policy",
+]