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.3.tar.gz (13.2 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.3-py3-none-any.whl (13.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: arc_ogchallenge-0.8.3.tar.gz
  • Upload date:
  • Size: 13.2 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.3.tar.gz
Algorithm Hash digest
SHA256 24ec53f132645392f7c5ec2f32b89d8fe32a5fc985ed048cc8bc10ed3d896677
MD5 639fc31ebfca9aa91474242e5a032c66
BLAKE2b-256 fc0653afd42f3f302ab6abc6219dd51482a4cbbcd2fce41e275c4a5378f9c62b

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for arc_ogchallenge-0.8.3-py3-none-any.whl
Algorithm Hash digest
SHA256 6eb20fee98137536e419b760cfc4331eec3ab39608ca8ae284c39f2a49c510f9
MD5 a6be5652ac33510f552375bbcef6df8a
BLAKE2b-256 82da162b53f5cde510d3ffbc9cc5811b92bbee030a8cd1b0ae8258b6d7485745

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