Rogii Solo.Papi.Types

ProxyData

attribute Scheme

Protocol scheme for the proxy connection.

SettingsAuth

attribute client_id	Client identifier for API authentication.
attribute client_secret	Client secret for API authentication.
attribute papi_domain_name	Domain name of the PAPI server.
attribute proxies	Proxy configuration for API connections.

PapiTrajectoryPoint

attribute md	Measured depth.
attribute incl	Inclination angle.
attribute azim	Azimuth angle.

PapiStarredHorizons

attribute top	The top starred horizon.
attribute center	The center starred horizon.
attribute bottom	The bottom starred horizon.

PapiStarredTops

attribute top	The top starred top.
attribute center	The center starred top.
attribute bottom	The bottom starred top.

PapiLogPoint

attribute index	Index value of the log point.
attribute value	Measured value at the log point.

PapiObjectCreationResult

attribute uuid

UUID of the newly created object.

Module Contents

class ProxyData

Bases: TypedDict

A TypedDict representing proxy configuration data for API connections.

Scheme: str

Protocol scheme for the proxy connection.

class SettingsAuth

Bases: NamedTuple

A NamedTuple containing authentication and connection settings for the PAPI client.

client_id: str

Client identifier for API authentication.

client_secret: str

Client secret for API authentication.

papi_domain_name: str

Domain name of the PAPI server.

proxies: ProxyData

Proxy configuration for API connections.

class PapiTrajectoryPoint

Bases: TypedDict

A TypedDict representing a trajectory point in the PAPI format.

md: PapiVar

Measured depth.

incl: PapiVar

Inclination angle.

azim: PapiVar

Azimuth angle.

class PapiStarredHorizons

Bases: TypedDict

A TypedDict representing the starred horizons in a PAPI object.

top: str

The top starred horizon.

center: str

The center starred horizon.

bottom: str

The bottom starred horizon.

class PapiStarredTops

Bases: TypedDict

A TypedDict representing the starred tops in a PAPI object.

top: str

The top starred top.

center: str

The center starred top.

bottom: str

The bottom starred top.

class PapiLogPoint

Bases: TypedDict

A TypedDict representing a log data point in the PAPI format.

index: PapiVar

Index value of the log point.

value: PapiVar

Measured value at the log point.

class PapiObjectCreationResult

Bases: TypedDict

A TypedDict representing the result of creating a new object in the PAPI system.

uuid: str

UUID of the newly created object.