Merge pull request #34 from askui/setup-telemetry

Setup telemetry

Author: adi-wan-askui

.env.template

@@ -4,3 +4,6 @@ TARS_API_KEY=
 
 # Anthropic API
 ANTHROPIC_API_KEY=
+
+# Telemetry
+ASKUI__VA__TELEMETRY__ENABLED=True # Set to "False" to disable telemetry

.github/workflows/checks.yaml

@@ -0,0 +1,21 @@
+name: Checks
+
+on:
+  pull_request:
+  push:
+    branches: [main]
+  workflow_call:
+
+jobs:
+  checks:
+    name: Run Checks
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 2
+      - uses: pdm-project/setup-pdm@v4
+        with:
+            cache: true
+      - run: pdm install
+      - run: pdm run test:unit

.github/workflows/publish.yaml

@@ -4,18 +4,18 @@ on:
 
 
 jobs:
+  call-reusable:
+    uses: ./.github/workflows/checks.yaml
   pypi-publish:
     name: upload release to PyPI
     runs-on: ubuntu-latest
     permissions:
-      # This permission is needed for private repositories.
-      contents: read
       # IMPORTANT: this permission is mandatory for trusted publishing
       id-token: write
     steps:
       - uses: actions/checkout@v4
-
       - uses: pdm-project/setup-pdm@v4
-
+        with:
+          cache: true
       - name: Publish package distributions to PyPI
         run: pdm publish

README.md

@@ -302,7 +302,7 @@ It connects Agent OS with powerful computer use models like Anthropic's Claude S
 
 **Agent OS** is a custom-built OS controller designed to enhance your automation experience.
 
- It offers powerful features like 
+ It offers powerful features like
  - multi-screen support,
  - support for all major operating systems (incl. Windows, MacOS and Linux),
  - process visualizations,
@@ -311,6 +311,19 @@ It connects Agent OS with powerful computer use models like Anthropic's Claude S
 and more exciting features like application selection, in background automation and video streaming are to be released soon.
 
 
+## Telemetry
+
+By default, we record usage data to detect and fix bugs inside the package and improve the UX of the package including
+- version of the `askui` package used
+- information about the environment, e.g., operating system, architecture, device id (hashed to protect privacy), python version
+- session id
+- some of the methods called including (non-sensitive) method parameters and responses, e.g., the click coordinates in `click(x=100, y=100)`
+- exceptions (types and messages)
+- AskUI workspace and user id if `ASKUI_WORKSPACE_ID` and `ASKUI_TOKEN` are set
+
+If you would like to disable the recording of usage data, set the `ASKUI__VA__TELEMETRY__ENABLED` environment variable to `False`.
+
+
 ## Experimental Features
 
 ### Chat

pdm.lock

@@ -1,6 +1,5 @@
 [project]
 name = "askui"
-version = "0.2.4"
 description = "Automate computer tasks in Python"
 authors = [
     {name = "askui GmbH", email = "info@askui.com"},
@@ -10,7 +9,7 @@ dependencies = [
     "grpcio-tools>=1.67.0",
     "pillow>=11.0.0",
     "pydantic>=2.9.2",
-    "anthropic>=0.37.1",
+    "anthropic>=0.49.0",
     "rich>=13.9.4",
     "pyperclip>=1.9.0",
     "gradio-client>=1.4.3",
@@ -20,20 +19,29 @@ dependencies = [
     "tenacity>=9.0.0",
     "python-dateutil>=2.9.0.post0",
     "openai>=1.61.1",
+    "segment-analytics-python>=2.3.4",
+    "py-machineid>=0.7.0",
+    "httpx>=0.28.1",
 ]
 requires-python = ">=3.10"
 readme = "README.md"
 license = {text = "MIT"}
+dynamic = ["version"]
 
 [build-system]
 requires = ["hatchling"]
 build-backend = "hatchling.build"
 
+[tool.hatch.version]
+path = "src/askui/__init__.py"
+
 [tool.pdm]
 distribution = true
 
 [tool.pdm.scripts]
 test = "pytest"
+"test:unit" = "pytest tests/unit"
+"test:integration" = "pytest tests/integration"
 sort = "isort ."
 format = "black ."
 lint = "ruff check ."
@@ -47,6 +55,7 @@ test = [
     "isort>=6.0.0",
     "black>=25.1.0",
     "ruff>=0.9.5",
+    "pytest-mock>=3.14.0",
 ]
 chat = [
     "streamlit>=1.42.0",

pyproject.toml

@@ -1,3 +1,7 @@
+"""AskUI Vision Agent"""
+
+__version__ = "0.2.4"
+
 from .agent import VisionAgent
 
 __all__ = [