askui 0.1.0__tar.gz

askui-0.1.0/.github/workflows/publish.yaml

@@ -0,0 +1,21 @@
+on:
+  release:
+    types: [published]
+
+
+jobs:
+  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
+
+      - name: Publish package distributions to PyPI
+        run: pdm publish

askui-0.1.0/.gitignore

@@ -0,0 +1,162 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm-project.org/#use-with-ide
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/

askui-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 AskUI GmbH
+
+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.

askui-0.1.0/PKG-INFO

@@ -0,0 +1,131 @@
+Metadata-Version: 2.3
+Name: askui
+Version: 0.1.0
+Summary: Automate anything with a vision agent.
+Author-email: askui GmbH <info@askui.com>
+License: MIT
+License-File: LICENSE
+Requires-Python: >=3.10
+Requires-Dist: anthropic>=0.37.1
+Requires-Dist: grpcio-tools>=1.67.0
+Requires-Dist: grpcio>=1.67.0
+Requires-Dist: pillow>=11.0.0
+Requires-Dist: pydantic>=2.9.2
+Description-Content-Type: text/markdown
+
+# 🤖 AskUI Vision Agent
+
+## 🔧 Setup
+
+### 1. Install AskUI Agent OS
+
+<details>
+  <summary>Windows</summary>
+  
+  ##### AMD64
+
+[AskUI Installer for AMD64](https://files.askui.com/releases/Installer/24.9.1/AskUI-Suite-24.9.1-Installer-Win-AMD64-Full.exe)
+
+##### ARM64
+
+[AskUI Installer for ARM64](https://files.askui.com/releases/Installer/24.9.1/AskUI-Suite-24.9.1-Installer-Win-ARM64-Full.exe)
+</details>
+
+
+<details>
+  <summary>Linux</summary>
+  
+##### AMD64
+
+```shell
+curl -o /tmp/AskUI-Suite-24.9.1-User-Installer-Linux-x64-Full.run https://files.askui.com/releases/Installer/24.9.1/AskUI-Suite-24.9.1-User-Installer-Linux-x64-Full.run
+
+bash /tmp/AskUI-Suite-24.9.1-User-Installer-Linux-x64-Full.run
+```
+
+##### ARM64
+
+
+```shell
+curl -o /tmp/AskUI-Suite-24.9.1-User-Installer-Linux-ARM64-Full.run https://files.askui.com/releases/Installer/24.9.1/AskUI-Suite-24.9.1-User-Installer-Linux-ARM64-Full.run
+
+bash /tmp/AskUI-Suite-24.9.1-User-Installer-Linux-ARM64-Full.run
+```
+</details>
+
+
+<details>
+  <summary>MacOS</summary>
+  
+```shell
+curl -o /tmp/AskUI-Suite-24.9.1-User-Installer-MacOS-ARM64-Full.run https://files.askui.com/releases/Installer/24.9.1/AskUI-Suite-24.9.1-User-Installer-MacOS-ARM64-Full.run
+
+bash /tmp/AskUI-Suite-24.9.1-User-Installer-MacOS-ARM64-Full.run
+```
+</details>
+
+
+### 2. Install vision-agent in your Python environment
+
+```shell
+pip install git+https://github.com/askui/vision-agent.git
+```
+
+### 3. Authenticate with Anthropic
+
+Set the `ANTHROPIC_API_KEY` environment variable to access the [Claude computer use model](https://docs.anthropic.com/en/docs/build-with-claude/computer-use). (Create a Anthropic key [here](https://console.anthropic.com/settings/keys))
+
+<details>
+  <summary>Linux & MacOS</summary>
+  
+  Use export to set an evironment variable:
+
+  ```shell
+  export ANTHROPIC_API_KEY=<your-api-key-here>
+  ```
+</details>
+
+<details>
+  <summary>Windows PowerShell</summary>
+  
+  Set an environment variable with $env:
+
+  ```shell
+  $env:ANTHROPIC_API_KEY="<your-api-key-here>"
+  ```
+</details>
+
+## ▶️ Start Building
+
+```python
+from askui import VisionAgent
+
+# Initialize your agent context manager
+with VisionAgent() as agent:
+    # Use the webbrowser tool to start browsing
+    agent.webbrowser.open_new("http://www.google.com")
+
+    # Start to automate individual steps
+    agent.click("url bar")
+    agent.type("http://www.google.com")
+    agent.keyboard("enter")
+
+    # Extract information from the screen
+    datetime = agent.get("What is the datetime at the top of the screen?")
+    print(datetime)
+
+    # Or let the agent work on its own
+    agent.act("search for a flight from Berlin to Paris in January")
+```
+
+
+### 📜 Logging
+
+You want a better understanding of what you agent is doing? Set the log_level to DEBUG.
+
+```python
+import logging
+
+with VisionAgent(log_level=logging.DEBUG) as agent:
+    agent...
+```

askui-0.1.0/README.md

@@ -0,0 +1,116 @@
+# 🤖 AskUI Vision Agent
+
+## 🔧 Setup
+
+### 1. Install AskUI Agent OS
+
+<details>
+  <summary>Windows</summary>
+  
+  ##### AMD64
+
+[AskUI Installer for AMD64](https://files.askui.com/releases/Installer/24.9.1/AskUI-Suite-24.9.1-Installer-Win-AMD64-Full.exe)
+
+##### ARM64
+
+[AskUI Installer for ARM64](https://files.askui.com/releases/Installer/24.9.1/AskUI-Suite-24.9.1-Installer-Win-ARM64-Full.exe)
+</details>
+
+
+<details>
+  <summary>Linux</summary>
+  
+##### AMD64
+
+```shell
+curl -o /tmp/AskUI-Suite-24.9.1-User-Installer-Linux-x64-Full.run https://files.askui.com/releases/Installer/24.9.1/AskUI-Suite-24.9.1-User-Installer-Linux-x64-Full.run
+
+bash /tmp/AskUI-Suite-24.9.1-User-Installer-Linux-x64-Full.run
+```
+
+##### ARM64
+
+
+```shell
+curl -o /tmp/AskUI-Suite-24.9.1-User-Installer-Linux-ARM64-Full.run https://files.askui.com/releases/Installer/24.9.1/AskUI-Suite-24.9.1-User-Installer-Linux-ARM64-Full.run
+
+bash /tmp/AskUI-Suite-24.9.1-User-Installer-Linux-ARM64-Full.run
+```
+</details>
+
+
+<details>
+  <summary>MacOS</summary>
+  
+```shell
+curl -o /tmp/AskUI-Suite-24.9.1-User-Installer-MacOS-ARM64-Full.run https://files.askui.com/releases/Installer/24.9.1/AskUI-Suite-24.9.1-User-Installer-MacOS-ARM64-Full.run
+
+bash /tmp/AskUI-Suite-24.9.1-User-Installer-MacOS-ARM64-Full.run
+```
+</details>
+
+
+### 2. Install vision-agent in your Python environment
+
+```shell
+pip install git+https://github.com/askui/vision-agent.git
+```
+
+### 3. Authenticate with Anthropic
+
+Set the `ANTHROPIC_API_KEY` environment variable to access the [Claude computer use model](https://docs.anthropic.com/en/docs/build-with-claude/computer-use). (Create a Anthropic key [here](https://console.anthropic.com/settings/keys))
+
+<details>
+  <summary>Linux & MacOS</summary>
+  
+  Use export to set an evironment variable:
+
+  ```shell
+  export ANTHROPIC_API_KEY=<your-api-key-here>
+  ```
+</details>
+
+<details>
+  <summary>Windows PowerShell</summary>
+  
+  Set an environment variable with $env:
+
+  ```shell
+  $env:ANTHROPIC_API_KEY="<your-api-key-here>"
+  ```
+</details>
+
+## ▶️ Start Building
+
+```python
+from askui import VisionAgent
+
+# Initialize your agent context manager
+with VisionAgent() as agent:
+    # Use the webbrowser tool to start browsing
+    agent.webbrowser.open_new("http://www.google.com")
+
+    # Start to automate individual steps
+    agent.click("url bar")
+    agent.type("http://www.google.com")
+    agent.keyboard("enter")
+
+    # Extract information from the screen
+    datetime = agent.get("What is the datetime at the top of the screen?")
+    print(datetime)
+
+    # Or let the agent work on its own
+    agent.act("search for a flight from Berlin to Paris in January")
+```
+
+
+### 📜 Logging
+
+You want a better understanding of what you agent is doing? Set the log_level to DEBUG.
+
+```python
+import logging
+
+with VisionAgent(log_level=logging.DEBUG) as agent:
+    agent...
+```