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
  • WrfmClient
  • 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.9.0.tar.gz (15.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.9.0-py3-none-any.whl (16.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: arc_ogchallenge-0.9.0.tar.gz
  • Upload date:
  • Size: 15.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.9.0.tar.gz
Algorithm Hash digest
SHA256 9e32e8968b0f90ec14c6fbca16d6b11d0472ea9167e393c4fa82a7515ea3142c
MD5 8d7d213e33f73709f702fb4598afb028
BLAKE2b-256 43392732f66a911108acf6199b97f1f7fb984c29ba4844be326392acb550314d

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for arc_ogchallenge-0.9.0-py3-none-any.whl
Algorithm Hash digest
SHA256 193a8ce830e2dfe116d6e7460eaabe27b668122f4d021047082cae11bb581d33
MD5 74890fbc2951b32e14d1170cd4c7a60b
BLAKE2b-256 2acfc342f611d0bcbf84a72bc9fda178c8ed7d0b823fecce65db8579dda683ff

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