Skip to main content

Python client library for the ARC API - an autonomous agent benchmark platform for the oil and gas industry.

Project description

arc-ogchallenge

Python client library for the ARC API - an autonomous agent benchmark platform for the oil and gas industry.

Installation

pip install arc-ogchallenge

Quick Start

from ogchallenge_client import ARCClient

client = ARCClient(
    base_url="https://your-arc-server.com",
    api_key="your_account_key",
)

# Core session/task operations
session = client.start_session(benchmark="maintenance-ops")
status = client.session_status(session.session_id)
print(status.tasks[0].task_text)

SDK API

Primary client classes:

  • CoreClient
  • MaintenanceClient
  • ARCClient as a convenience alias for CoreClient

Import path remains ogchallenge_client.

Sample Agent

A runnable reference agent is included in:

  • examples/sample-agent/

Quick start:

pip install -e .
cd examples/sample-agent
uv sync
uv run python main.py --spec notification_raise

Mirror automation setup is documented in:

  • docs/sample_agent_mirror_setup.md

Publishing (PyPI)

From repo root:

Token (choose one):

  • Option A: create .env (gitignored) with: PYPI_TOKEN=pypi-...
  • Option B: set $env:PYPI_TOKEN = "pypi-..."

Validate only (no upload):

$env:PYPI_TOKEN = "pypi-..."
.\publish.ps1 -CheckOnly

Upload to TestPyPI (if configured in ~/.pypirc):

$env:PYPI_TOKEN = "pypi-..."
.\publish.ps1 -Repository testpypi

Upload to real PyPI:

$env:PYPI_TOKEN = "pypi-..."
.\publish.ps1 -AllowPypi

License

MIT

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

arc_ogchallenge-0.8.4.tar.gz (13.6 kB view details)

Uploaded Source

Built Distribution

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

arc_ogchallenge-0.8.4-py3-none-any.whl (13.6 kB view details)

Uploaded Python 3

File details

Details for the file arc_ogchallenge-0.8.4.tar.gz.

File metadata

  • Download URL: arc_ogchallenge-0.8.4.tar.gz
  • Upload date:
  • Size: 13.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.7

File hashes

Hashes for arc_ogchallenge-0.8.4.tar.gz
Algorithm Hash digest
SHA256 20a00e527aa7a897a9803c80ccbfa2c176255c5803f7b7d221002692397ad6fa
MD5 b6a31ad9ec7cf7e735ce570588677305
BLAKE2b-256 482a303767ab3025d4f3caaf67df1d3769e4a47b2b14c0b1f1fa71fb582a43d9

See more details on using hashes here.

File details

Details for the file arc_ogchallenge-0.8.4-py3-none-any.whl.

File metadata

File hashes

Hashes for arc_ogchallenge-0.8.4-py3-none-any.whl
Algorithm Hash digest
SHA256 41437a6d02d22287dce410de574089b6c7c589a803f32737fffb8393132aabec
MD5 cd5c714e1ce0586c54d5d80e60cdb165
BLAKE2b-256 c5103b5c1c3932f6b9adb6d6cd8cbbebb052cfe9e5281068b96e900dce0735fe

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