Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

aiocua

A Simple Python CUA (Computer Use Agent) Solution

Status

This project is in Technical Preview.

  • APIs are subject to change.
  • Not ready for production use.

Supported Platforms

  • Windows
  • macOS

Installation

pip install aiocua

Quick Start

import asyncio
from aiocua import CuaOperator

async def main():
    operator = CuaOperator()

    # Get screen dimensions
    width, height = await operator.dimensions()

    # Take a screenshot (returns base64-encoded string)
    screenshot_base64 = await operator.screenshot()

    # Get monitor info
    monitors = await operator.monitors()
    for m in monitors:
        print(f"Monitor {m.id}: {m.width}x{m.height} (scale={m.scale}, primary={m.primary})")

if __name__ == "__main__":
    asyncio.run(main())

API Reference

All methods on CuaOperator are async.

Mouse

Method Description
move(x, y) Move the cursor to the given coordinates.
click(button="left", x=None, y=None) Click a mouse button. Supported buttons: left, right, wheel, back, forward. If x/y are provided, moves first.
double_click(x=None, y=None) Double-click at the current or given position.
drag(path) Drag along a list of (x, y) coordinates.
scroll(scroll_x, scroll_y, x=None, y=None) Scroll by the given amounts. Optionally move to x/y first.

Keyboard

Method Description
key_press(keys) Press one or more keys simultaneously (e.g. ["CTRL", "C"]). Keys are automatically remapped per platform.
type_text(text) Type a string of text, including Unicode characters.

Screen

Method Description
screenshot() Capture the screen and return it as a base64-encoded PNG string.
dimensions() Return the primary monitor resolution as (width, height).
monitors() Return a list of MonitorMetadata for each connected display.

Other

Method Description
wait() Wait for any pending operations to complete.

Testing

pip install aiocua[test]
pytest

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

aiocua-0.0.0a1.tar.gz (17.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

aiocua-0.0.0a1-py3-none-any.whl (19.7 kB view details)

Uploaded Python 3

File details

Details for the file aiocua-0.0.0a1.tar.gz.

File metadata

  • Download URL: aiocua-0.0.0a1.tar.gz
  • Upload date:
  • Size: 17.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for aiocua-0.0.0a1.tar.gz
Algorithm Hash digest
SHA256 54cf501eef62d69ee175c1c4f25f1a10db020d20bac84d8af1e556599125cae5
MD5 0eef9624b8d74f1bee8540467b2e3765
BLAKE2b-256 a510a8ba44648a7f5838a471793c6e1e41e5c736e484d8a791f37b2c5110406f

See more details on using hashes here.

Provenance

The following attestation bundles were made for aiocua-0.0.0a1.tar.gz:

Publisher: publish.yml on yangyuan/aiocua

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file aiocua-0.0.0a1-py3-none-any.whl.

File metadata

  • Download URL: aiocua-0.0.0a1-py3-none-any.whl
  • Upload date:
  • Size: 19.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for aiocua-0.0.0a1-py3-none-any.whl
Algorithm Hash digest
SHA256 1c598e98ac5821caefe878d04a454ab3d4205e7f27e5c53ec9efe5cfb6f05981
MD5 53a2d06fdd90180a8556bd7be501f2e3
BLAKE2b-256 e01245bae21822ec98c345aeecf5a970b2a29f35ed69ebc69e5ca2e840d91b95

See more details on using hashes here.

Provenance

The following attestation bundles were made for aiocua-0.0.0a1-py3-none-any.whl:

Publisher: publish.yml on yangyuan/aiocua

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

This release

0.0.0a1 This release

2 files

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page