whitson-plus-connect 0.1.0

Python SDK helpers for the whitson+ external API.

whitson+ Connect SDK

Python SDK for the whitson+ external API.

Use this package to authenticate with whitson⁺, read well and production data, upload production data, update wells, and connect whitson⁺ to database workflows.

Install

Install it with:

pip install whitson-plus-connect

For Databricks SQL connector workflows:

pip install "whitson-plus-connect[databricks]"

For Snowflake workflows:

pip install "whitson-plus-connect[snowflake]"

For SQL Server or other ODBC workflows:

pip install "whitson-plus-connect[odbc]"

Usage

Set your API credentials as environment variables:

export WHITSON_CLIENT_NAME="your_domain"
export WHITSON_CLIENT_ID="your_client_id"
export WHITSON_CLIENT_SECRET="your_client_secret"
export WHITSON_PROJECT_ID="123"

Values set with export are available only in that terminal session and to programs started from that terminal.

import os

from whitson_plus_connect import WhitsonClient

client = WhitsonClient.from_env().authenticate()
wells = client.wells.list(int(os.environ["WHITSON_PROJECT_ID"]))
well = client.wells.get(well_id=123)

Existing whitson_connect workflows can keep using WhitsonConnection directly:

from whitson_plus_connect import WhitsonConnection

whitson_connection = WhitsonConnection(
    client_name="your_domain",
    client_id="your_client_id",
    client_secret="your_client_secret",
)
whitson_connection.authenticate()

When using WhitsonClient, the underlying WhitsonConnection is still available as client.connection for scripts that need the original Whitson Connect method names.

Database integrations

Database helpers are available through the SDK client:

client.snowflake.connect(...)
client.snowflake.query_to_dataframe(...)

client.databricks.connect_sql(...)
client.databricks.connect(...)
client.databricks.connect_oauth2(...)

client.prodman.get_wells(...)
client.prodman.get_production(...)

Install the matching optional dependency before using these helpers:

pip install "whitson-plus-connect[snowflake]"
pip install "whitson-plus-connect[databricks]"
pip install "whitson-plus-connect[odbc]"

Documentation

See the whitson⁺ external API manual for setup steps and workflow examples:

https://manual.whitson.com/external_api/sdk/