ComboCurve API Helper combocurve-api-helper

A utility library mapped to ComboCurve's API.

Petroleum Engineering Toolbox

Open in Visual Studio Code

Features

combocurve-api-helper wraps the ComboCurve REST API behind a single ComboCurveAPI entrypoint that composes one mixin per resource area:

• Projects, scenarios, wells — list / create / update / delete, plus custom columns.
• Production — daily and monthly volumes.
• Forecasts & type curves — read forecasts, write forecast parameters, and put_forecast_parameters_batched() for parallel, chunked (25 well x phase per request), 207-aware bulk writes that return a BatchWriteResult (per-record success_count / failed_count / ok, results in original payload order).
• Forecast runs — submit a forecast run as an async job and poll its status.
• Econ models — CREATE / UPDATE / DELETE for econ-model types (project per-type and generic; company generics), plus an exact, invertible API <-> CSV column mapping for 11 econ-model types.
• Econ-model assignments — assign / unassign models to wells per scenario qualifier, and read the scenario assignment grid.
• Lookup tables — scenario, type-curve, and scenario-assignment CRUD.
• Econ runs — trigger scenario economics and read results.
• Directional — directional survey access.
• Resilient transport — automatic retry with backoff on HTTP 429 (honoring Retry-After) and transient gateway errors (502 / 503 / 504).

Method docstrings carry an Example response: block and a link to the matching docs.api.combocurve.com operation (see Docstring examples). See CHANGELOG.md for release history.

Installation

Install from Python package repository:

python -m pip install combocurve-api-helper

or install directly from GitHub:

python -m pip install git+https://github.com/petbox-dev/combocurve-api-helper.git@main

Setup

Two files are required in ~/.combocurve:

• cc-api.config.json
• combocurve.json

These are given by ComboCurve when configuring API access. Example files are provided in ./config-examples/ to demonstrate the expected file structures.

cc-api.config.example.json:

{
    "apikey": "<apikey>"
}

combocurve.example.json:

{
  "type": "service_account",
  "project_id": "beta-combocurve",
  "private_key_id": "<private_key_id>",
  "private_key": "<private_key>",
  "client_email": "<client_email>",
  "client_id": "<client_id>",
  "auth_uri": "https://accounts.google.com/o/oauth2/auth",
  "token_uri": "https://oauth2.googleapis.com/token",
  "auth_provider_x509_cert_url": "https://www.googleapis.com/oauth2/v1/certs",
  "client_x509_cert_url": "<client_x509_cert_url>"
}

Usage

from combocurve_api_helper import ComboCurveAPI

# Credentials are read from ~/.combocurve (see Setup above)
api = ComboCurveAPI()

# List projects, then scenarios and forecasts within one
projects = api.get_projects(filters={'name': 'Example Project'})
project_id = api.extract_id(projects)

scenarios = api.get_scenarios(project_id)
forecasts = api.get_forecasts(project_id)

# Bulk-write forecast parameters in parallel: chunked and 207-aware
result = api.put_forecast_parameters_batched(project_id, forecast_id, records)
if not result.ok:
    print(f"{result.failed_count} of {len(result.results)} records failed")

Econ models to / from CSV

Each econ-model type has an invertible mapper looked up by its PascalCase econModelType. The library exposes per-type convenience functions that convert a whole multi-model CSV (the shape ComboCurve exports) directly to and from lists of API dicts, so no csv boilerplate is needed. to_csv/from_csv work on strings; read_csv/write_csv (on the mapper) work on file paths.

from combocurve_api_helper import ComboCurveAPI
from combocurve_api_helper.econ_models import (
    expenses_to_csv,
    expenses_from_csv,
    get_expenses_mapper,
)

api = ComboCurveAPI()

# --- ComboCurve -> CSV file ---
models = [api.get_expenses_model_by_id(project_id, model_id)]
get_expenses_mapper().write_csv("expenses.csv", models)

# --- CSV file -> ComboCurve ---
payloads = get_expenses_mapper().read_csv("expenses.csv")   # list[dict], one per model
api.post_expenses_models(project_id, payloads)              # or put_expenses_models(...)

# --- In-memory string round trip ---
csv_text = expenses_to_csv(models)
same_models = expenses_from_csv(csv_text)

For finer-grained, per-model control, drop to the row level. to_row_dicts flattens a single model to its CSV-column-keyed row dicts (no header, no file); from_row_dicts rebuilds one model from rows. Use these when you want to drive the csv writer yourself, edit or filter individual rows, or handle models one at a time. The whole-file helpers above are built on them, and mapper.columns is the exact CSV header.

import csv
from combocurve_api_helper import ComboCurveAPI
from combocurve_api_helper.econ_models import get_expenses_mapper

api = ComboCurveAPI()
mapper = get_expenses_mapper()
model = api.get_expenses_model_by_id(project_id, model_id)   # one Expenses econ-model API dict

# --- one model -> row dicts -> your own CSV file ---
with open("expenses.csv", "w", newline="") as f:
    writer = csv.DictWriter(f, fieldnames=mapper.columns)   # columns == the CSV header
    writer.writeheader()
    writer.writerows(mapper.to_row_dicts(model))            # one model's line-item rows

# --- row dicts -> one model ---
with open("expenses.csv", newline="") as f:
    rows = list(csv.DictReader(f))
payload = mapper.from_row_dicts(rows)                       # reconstruct a single API payload

Contributing

1. Fork the repository:

   • On this GitHub page, click "Fork" to create a copy under your own account.

2. Clone the forked repo onto on your machine:

   git clone https://github.com/<your-username>/combocurve-api-helper.git
   cd combocurve-api-helper
   

3. Set the upstream remote:

   • This allows you to fetch updates from the original repository:

   git remote add upstream https://github.com/petbox-dev/combocurve-api-helper.git
   

4. Create a new branch:

   • Always create a new branch for your feature or fix
   • A common convention is to name the branch your GitHub username, a forward slash, and a brief description of the work you're doing

   git checkout -b <your-username>/<your-branch-name>
   

5. Make your changes, and commit:

   • After adding your files, or making edits, ensure typechecking succeeds, then commit your changes

   mypy --package combocurve_api_helper
   
   git add .
   git commit -m "<description of changes>"
   

6. Push to your fork:

   git push origin <the-name-of-your-branch>
   

7. Create a pull request:

   • Go to "Pull Requests" tab in this repo, and click "compare across forks"
   • Choose your branch as the source and keep the default main branch as the target
     • ie: petbox-dev/combocurve-api-helper (main) <- your-username/combocurve-api-helper (your-branch-name)
   • Fill the title and description with a summary of the proposed changes
   • Request a review from @dsfulf

Docstring examples

The Example response: / Example data: blocks in method docstrings are generated from the ComboCurve Postman collection — do not edit them by hand. The collection's <type> placeholders (<string>, <number>, <boolean>, …) are filled with realistic, deterministic spoof values (numbers as numbers, bools as bools, ISO dates, ObjectId-like ids), so a docstring shows the response's key/value shape without a live API call. Refresh after the API changes:

python scripts/generate_docstrings.py          # rewrite in place
python scripts/generate_docstrings.py --check   # verify; exit 1 if stale, 2 if unreachable

Each method is matched to its operation by the docs.api.combocurve.com/api/<slug> link in its docstring, where <slug> is the collection item name. (The OpenAPI spec at storage.googleapis.com/beta-combocurve-api-docs/openapi-spec.yaml has real example values, but is an older/less-complete snapshot — missing ~52 operations as of 2026-07 — so the collection is used instead.)

Authors

• David Fulford

License

MIT License

Copyright (c) 2023 Petroleum Engineering Toolbox

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.