Skip to main content

Python CLI and SDK helpers for Domrun Browser, MCP registries, and GPT/Codex automation workflows.

Project description

Domrun Python CLI and SDK

domrun is the Python distribution for Domrun Browser setup, diagnostics, and customer-owned MCP registry onboarding. It provides the same domrun command as the npm package, plus small Python helpers for backend integration tests.

Install

After the package is published to PyPI:

pip install domrun
domrun --help

With uv:

uv tool install domrun
domrun --help

Run without installing globally:

uvx domrun --help

For a project virtual environment:

uv pip install domrun

Configure a customer backend

domrun init \
  --registry-url https://mcp.customer.com \
  --automation-url https://automation.customer.com \
  --mcp-url https://mcp.customer.com/mcp \
  --user-key customer-acme:user_123 \
  --codex

This writes ~/.domrun/config.json. With --codex, it also writes:

  • ~/.codex/config.toml with a domrun MCP server entry
  • AGENTS.md in the current project with Domrun usage guidance for GPT/Codex agents

Useful commands

domrun browser open https://example.com
domrun connect "https://mcp.customer.com/v1/domrun/connect-sessions/cs_123"
domrun status
domrun browser status
domrun codex install --mcp-url https://mcp.customer.com/mcp
domrun mcp status
domrun doctor
domrun tools list

Python helper

from domrun import DomrunClient

client = DomrunClient(
    backend_url="https://mcp.customer.com",
    service_token="service-token",
)

session = client.create_connect_session(
    tenant_id="customer-acme",
    user_id="user_123",
    user_key="customer-acme:user_123",
    registry_url="https://mcp.customer.com",
    automation_url="https://automation.customer.com",
    browser_alias="Faizan's MacBook",
)

print(session["browser_connect_url"])

Publish to PyPI

The package is configured for public PyPI distribution as domrun.

Build and check locally:

uv run --with build python -m build
uv run --with twine python -m twine check dist/*

Publish after logging into the account that should own the package:

uv run --with twine python -m twine upload dist/*

For CI, use a PyPI trusted publisher or set TWINE_USERNAME=__token__ and TWINE_PASSWORD=<pypi-token>.

Project details


Download files

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

Source Distribution

domrun-0.1.0.tar.gz (11.1 kB view details)

Uploaded Source

Built Distribution

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

domrun-0.1.0-py3-none-any.whl (10.0 kB view details)

Uploaded Python 3

File details

Details for the file domrun-0.1.0.tar.gz.

File metadata

  • Download URL: domrun-0.1.0.tar.gz
  • Upload date:
  • Size: 11.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.3

File hashes

Hashes for domrun-0.1.0.tar.gz
Algorithm Hash digest
SHA256 85444fa89ca320ee4190523ff405bc305206c33784e3d54f283515871a2553e1
MD5 fb01e18a4a6407fb0142ef83e54c9320
BLAKE2b-256 143b4636f3adca7e7c374f09ec189ac68b2bd99763a3c5246ee6101d7c7afaae

See more details on using hashes here.

File details

Details for the file domrun-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: domrun-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 10.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.3

File hashes

Hashes for domrun-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 16342c94b4ae6b8a410f79dc75c88f4a62d553546728682551bebe9a0cc1d95c
MD5 7c9acb33df3d214d4df6678e8442798e
BLAKE2b-256 5102e1e17e26dee87bcc616def59b6b4b96c74db264bc1bdf151a2aef4ffb305

See more details on using hashes here.

Supported by

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