osdu-python-models 0.5.0__py3-none-any.whl

osdu_models/abstract/abstract_feature_collection/v1_0_0.py

@@ -0,0 +1,227 @@
+# generated by datamodel-codegen:
+#   filename:  abstract/abstract_feature_collection/v1_0_0.json
+
+from __future__ import annotations
+from enum import Enum
+from pydantic import BaseModel, ConfigDict, Field, RootModel
+from typing import Any
+
+
+class Type(Enum):
+    FeatureCollection = 'FeatureCollection'
+
+
+class Type16(Enum):
+    Feature = 'Feature'
+
+
+class Type17(Enum):
+    Point = 'Point'
+
+
+class Geometry(BaseModel):
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    type: Type17
+    coordinates: list[float] = Field(..., min_length=2)
+    bbox: list[float] | None = Field(None, min_length=4)
+
+
+class Type18(Enum):
+    LineString = 'LineString'
+
+
+class Coordinate(RootModel[list[float]]):
+    root: list[float]
+
+
+class Geometry9(BaseModel):
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    type: Type18
+    coordinates: list[Coordinate] = Field(..., min_length=2)
+    bbox: list[float] | None = Field(None, min_length=4)
+
+
+class Type19(Enum):
+    Polygon = 'Polygon'
+
+
+class Geometry10(BaseModel):
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    type: Type19
+    coordinates: list[list[Coordinate]]
+    bbox: list[float] | None = Field(None, min_length=4)
+
+
+class Type20(Enum):
+    MultiPoint = 'MultiPoint'
+
+
+class Geometry11(BaseModel):
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    type: Type20
+    coordinates: list[list[float]]
+    bbox: list[float] | None = Field(None, min_length=4)
+
+
+class Type21(Enum):
+    MultiLineString = 'MultiLineString'
+
+
+class Geometry12(BaseModel):
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    type: Type21
+    coordinates: list[list[Coordinate]]
+    bbox: list[float] | None = Field(None, min_length=4)
+
+
+class Type22(Enum):
+    MultiPolygon = 'MultiPolygon'
+
+
+class Geometry13(BaseModel):
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    type: Type22
+    coordinates: list[list[list[Coordinate]]]
+    bbox: list[float] | None = Field(None, min_length=4)
+
+
+class Type23(Enum):
+    GeometryCollection = 'GeometryCollection'
+
+
+class Type24(Enum):
+    Point = 'Point'
+
+
+class Geometries(BaseModel):
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    type: Type24
+    coordinates: list[float] = Field(..., min_length=2)
+    bbox: list[float] | None = Field(None, min_length=4)
+
+
+class Type25(Enum):
+    LineString = 'LineString'
+
+
+class Geometries7(BaseModel):
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    type: Type25
+    coordinates: list[Coordinate] = Field(..., min_length=2)
+    bbox: list[float] | None = Field(None, min_length=4)
+
+
+class Type26(Enum):
+    Polygon = 'Polygon'
+
+
+class Geometries8(BaseModel):
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    type: Type26
+    coordinates: list[list[Coordinate]]
+    bbox: list[float] | None = Field(None, min_length=4)
+
+
+class Type27(Enum):
+    MultiPoint = 'MultiPoint'
+
+
+class Geometries9(BaseModel):
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    type: Type27
+    coordinates: list[list[float]]
+    bbox: list[float] | None = Field(None, min_length=4)
+
+
+class Type28(Enum):
+    MultiLineString = 'MultiLineString'
+
+
+class Geometries10(BaseModel):
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    type: Type28
+    coordinates: list[list[Coordinate]]
+    bbox: list[float] | None = Field(None, min_length=4)
+
+
+class Type29(Enum):
+    MultiPolygon = 'MultiPolygon'
+
+
+class Geometries11(BaseModel):
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    type: Type29
+    coordinates: list[list[list[Coordinate]]]
+    bbox: list[float] | None = Field(None, min_length=4)
+
+
+class Geometry14(BaseModel):
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    type: Type23
+    geometries: list[
+        Geometries
+        | Geometries7
+        | Geometries8
+        | Geometries9
+        | Geometries10
+        | Geometries11
+    ]
+    bbox: list[float] | None = Field(None, min_length=4)
+
+
+class Feature(BaseModel):
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    type: Type16
+    properties: dict[str, Any] | None
+    geometry: (
+        Geometry
+        | Geometry9
+        | Geometry10
+        | Geometry11
+        | Geometry12
+        | Geometry13
+        | Geometry14
+        | None
+    )
+    bbox: list[float] | None = Field(None, min_length=4)
+
+
+class GeojsonFeaturecollection(BaseModel):
+    """
+    GeoJSON feature collection as originally published in https://geojson.org/schema/FeatureCollection.json. Attention: the coordinate order is fixed: Longitude first, followed by Latitude, optionally height above MSL (EPSG:5714) as third coordinate.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    type: Type
+    features: list[Feature]
+    bbox: list[float] | None = Field(None, min_length=4)

osdu_models/abstract/abstract_file/__init__.py

@@ -0,0 +1,2 @@
+# generated by datamodel-codegen:
+#   filename:  tmp4rfivwe4

osdu_models/abstract/abstract_file/v1_0_0.py

@@ -0,0 +1,44 @@
+# generated by datamodel-codegen:
+#   filename:  abstract/abstract_file/v1_0_0.json
+
+from __future__ import annotations
+from pydantic import BaseModel, ConfigDict, Field, constr
+from ..abstract_file_source_info import v1_0_0
+
+
+class DatasetProperties(BaseModel):
+    """
+    The dataset properties for a single file.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    FileSourceInfo: v1_0_0.AbstractFileSourceInfo | None = Field(
+        None, title='File Source Info'
+    )
+    """
+    Information about the single file.
+    """
+
+
+class AbstractFile(BaseModel):
+    """
+    The schema fragment representing single files
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    DatasetProperties_1: DatasetProperties = Field(
+        ..., alias='DatasetProperties', title='Dataset Properties'
+    )
+    """
+    The dataset properties for a single file.
+    """
+    Checksum: constr(pattern=r'^[0-9a-fA-F]{32}') | None = Field(
+        None, examples=['d41d8cd98f00b204e9800998ecf8427e'], title='MD5 Checksum'
+    )
+    """
+    MD5 checksum of file bytes - a 32 byte hexadecimal number.
+    """

osdu_models/abstract/abstract_file/v1_0_1.py

@@ -0,0 +1,44 @@
+# generated by datamodel-codegen:
+#   filename:  abstract/abstract_file/v1_0_1.json
+
+from __future__ import annotations
+from pydantic import BaseModel, ConfigDict, Field, constr
+from ..abstract_file_source_info import v1_0_1
+
+
+class DatasetProperties(BaseModel):
+    """
+    The dataset properties for a single file.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    FileSourceInfo: v1_0_1.AbstractFileSourceInfo | None = Field(
+        None, title='File Source Info'
+    )
+    """
+    Information about the single file.
+    """
+
+
+class AbstractFile(BaseModel):
+    """
+    The schema fragment representing single files
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    DatasetProperties_1: DatasetProperties = Field(
+        ..., alias='DatasetProperties', title='Dataset Properties'
+    )
+    """
+    The dataset properties for a single file.
+    """
+    Checksum: constr(pattern=r'^[0-9a-fA-F]{32}') | None = Field(
+        None, examples=['d41d8cd98f00b204e9800998ecf8427e'], title='MD5 Checksum'
+    )
+    """
+    MD5 checksum of file bytes - a 32 byte hexadecimal number.
+    """

osdu_models/abstract/abstract_file_collection/__init__.py

@@ -0,0 +1,2 @@
+# generated by datamodel-codegen:
+#   filename:  tmp4rfivwe4

osdu_models/abstract/abstract_file_collection/v1_0_0.py

@@ -0,0 +1,89 @@
+# generated by datamodel-codegen:
+#   filename:  abstract/abstract_file_collection/v1_0_0.json
+
+from __future__ import annotations
+from pydantic import BaseModel, ConfigDict, Field, constr
+from ..abstract_file_source_info import v1_0_0
+
+
+class DatasetProperties(BaseModel):
+    """
+    The dataset properties for a file collection.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    FileCollectionPath: str = Field(
+        ...,
+        examples=['s3://default_bucket/opendes/data/vds-dataset/'],
+        title='File Collection Path',
+    )
+    """
+    The mandatory path to the file collection. A FileCollectionPath should represent folder level access to a set of files.
+    """
+    IndexFilePath: str | None = Field(
+        None,
+        examples=['s3://default_bucket/opendes/data/vds-dataset/vds-dataset.index'],
+        title='Index File Path',
+    )
+    """
+    An optional path to an index file.
+    """
+    FileSourceInfos: list[v1_0_0.AbstractFileSourceInfo] | None = Field(
+        None,
+        examples=[
+            [
+                {
+                    'FileSource': 's3://default_bucket/opendes/data/vds-dataset/vds-file-1',
+                    'PreloadFilePath': 's3://staging-area/r7/raw-data/provided/documents/vds-file-1',
+                    'Name': 'vds-file-1',
+                    'PreloadFileCreateUser': 'somebody@acme.org',
+                    'PreloadFileCreateDate': '2019-12-16T11:46:20.163Z',
+                    'PreloadFileModifyUser': 'somebody.else@acme.org',
+                    'PreloadFileModifyDate': '2019-12-20T17:20:05.356Z',
+                    'FileSize': '439452464',
+                    'Checksum': 'd41d8cd98f00b204e9800998ecf8427e',
+                    'ChecksumAlgorithm': 'MD5',
+                },
+                {
+                    'FileSource': 's3://default_bucket/opendes/data/vds-dataset/vds-file-2',
+                    'PreloadFilePath': 's3://staging-area/r7/raw-data/provided/documents/vds-file-2',
+                    'Name': 'vds-file-2',
+                    'PreloadFileCreateUser': 'somebody@acme.org',
+                    'PreloadFileCreateDate': '2019-12-16T11:50:40.321Z',
+                    'PreloadFileModifyUser': 'somebody.else@acme.org',
+                    'PreloadFileModifyDate': '2019-12-20T17:59:03.456Z',
+                    'FileSize': '433645463',
+                    'Checksum': '204e9800998ecf8427ed41d8cd98f00b',
+                    'ChecksumAlgorithm': 'MD5',
+                },
+            ]
+        ],
+        title='File Source Info Array',
+    )
+    """
+    Array of file collection members as FileSourceInfo.
+    """
+    Checksum: constr(pattern=r'^[0-9a-fA-F]{32}') | None = Field(
+        None, examples=['d41d8cd98f00b204e9800998ecf8427e'], title='MD5 Checksum'
+    )
+    """
+    MD5 checksum of file bytes - a 32 byte hexadecimal number.
+    """
+
+
+class AbstractFileCollection(BaseModel):
+    """
+    The schema fragment representing file collections.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    DatasetProperties_1: DatasetProperties = Field(
+        ..., alias='DatasetProperties', title='Dataset Properties'
+    )
+    """
+    The dataset properties for a file collection.
+    """

osdu_models/abstract/abstract_file_collection/v1_0_1.py

@@ -0,0 +1,89 @@
+# generated by datamodel-codegen:
+#   filename:  abstract/abstract_file_collection/v1_0_1.json
+
+from __future__ import annotations
+from pydantic import BaseModel, ConfigDict, Field, constr
+from ..abstract_file_source_info import v1_0_1
+
+
+class DatasetProperties(BaseModel):
+    """
+    The dataset properties for a file collection.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    FileCollectionPath: str = Field(
+        ...,
+        examples=['s3://default_bucket/opendes/data/vds-dataset/'],
+        title='File Collection Path',
+    )
+    """
+    The mandatory path to the file collection. A FileCollectionPath should represent folder level access to a set of files.
+    """
+    IndexFilePath: str | None = Field(
+        None,
+        examples=['s3://default_bucket/opendes/data/vds-dataset/vds-dataset.index'],
+        title='Index File Path',
+    )
+    """
+    An optional path to an index file.
+    """
+    FileSourceInfos: list[v1_0_1.AbstractFileSourceInfo] | None = Field(
+        None,
+        examples=[
+            [
+                {
+                    'FileSource': 's3://default_bucket/opendes/data/vds-dataset/vds-file-1',
+                    'PreloadFilePath': 's3://staging-area/r7/raw-data/provided/documents/vds-file-1',
+                    'Name': 'vds-file-1',
+                    'PreloadFileCreateUser': 'somebody@acme.org',
+                    'PreloadFileCreateDate': '2019-12-16T11:46:20.163Z',
+                    'PreloadFileModifyUser': 'somebody.else@acme.org',
+                    'PreloadFileModifyDate': '2019-12-20T17:20:05.356Z',
+                    'FileSize': '439452464',
+                    'Checksum': 'd41d8cd98f00b204e9800998ecf8427e',
+                    'ChecksumAlgorithm': 'MD5',
+                },
+                {
+                    'FileSource': 's3://default_bucket/opendes/data/vds-dataset/vds-file-2',
+                    'PreloadFilePath': 's3://staging-area/r7/raw-data/provided/documents/vds-file-2',
+                    'Name': 'vds-file-2',
+                    'PreloadFileCreateUser': 'somebody@acme.org',
+                    'PreloadFileCreateDate': '2019-12-16T11:50:40.321Z',
+                    'PreloadFileModifyUser': 'somebody.else@acme.org',
+                    'PreloadFileModifyDate': '2019-12-20T17:59:03.456Z',
+                    'FileSize': '433645463',
+                    'Checksum': '204e9800998ecf8427ed41d8cd98f00b',
+                    'ChecksumAlgorithm': 'MD5',
+                },
+            ]
+        ],
+        title='File Source Info Array',
+    )
+    """
+    Array of file collection members as FileSourceInfo.
+    """
+    Checksum: constr(pattern=r'^[0-9a-fA-F]{32}') | None = Field(
+        None, examples=['d41d8cd98f00b204e9800998ecf8427e'], title='MD5 Checksum'
+    )
+    """
+    MD5 checksum of file bytes - a 32 byte hexadecimal number.
+    """
+
+
+class AbstractFileCollection(BaseModel):
+    """
+    The schema fragment representing file collections.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    DatasetProperties_1: DatasetProperties = Field(
+        ..., alias='DatasetProperties', title='Dataset Properties'
+    )
+    """
+    The dataset properties for a file collection.
+    """

osdu_models/abstract/abstract_file_source_info/__init__.py

@@ -0,0 +1,2 @@
+# generated by datamodel-codegen:
+#   filename:  tmp4rfivwe4

osdu_models/abstract/abstract_file_source_info/v1_0_0.py

@@ -0,0 +1,92 @@
+# generated by datamodel-codegen:
+#   filename:  abstract/abstract_file_source_info/v1_0_0.json
+
+from __future__ import annotations
+from pydantic import BaseModel, ConfigDict, Field, constr
+
+
+class AbstractFileSourceInfo(BaseModel):
+    """
+    A schema fragment to describe file source information.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    FileSource: str = Field(
+        ...,
+        examples=['s3://default_bucket/r1/data/provided/documents/1000.witsml'],
+        title='File Source',
+    )
+    """
+    The location of the file. It can be a relative path. The actual access is provided via the File Service. When used in context of a FileCollection (dataset--FileCollection*) FileSource is a relative path from the FileCollectionPath. It can be used by consumers to pull an individual file if they so choose by concatenating the FileCollectionPath with the FileSource. This property is required.
+    """
+    PreloadFilePath: str | None = Field(
+        None,
+        examples=['s3://staging-area/r7/raw-data/provided/documents/1000.witsml'],
+        title='Preload File Path',
+    )
+    """
+    File system path to the data file as it existed before loading to the data platform.
+    """
+    PreloadFileCreateUser: str | None = Field(
+        None, examples=['somebody@acme.org'], title='Preload File Create User'
+    )
+    """
+    Optional user name or reference, who created the file prior to up-loading to the platform.
+    """
+    PreloadFileCreateDate: str | None = Field(
+        None, examples=['2019-12-16T11:46:20.163Z'], title='Preload File Create Date'
+    )
+    """
+    Optional create date and time of the file prior to up-loading to the platform.
+    """
+    PreloadFileModifyUser: str | None = Field(
+        None, examples=['somebody.else@acme.org'], title='Preload File Modify User'
+    )
+    """
+    Optional user name or reference, who last modified the file prior to up-loading to the platform.
+    """
+    PreloadFileModifyDate: str | None = Field(
+        None, examples=['2019-12-20T17:20:05.356Z'], title='Preload File Modify Date'
+    )
+    """
+    Optional last modified date and time of the file prior to up-loading to the platform.
+    """
+    Name: str | None = Field(None, examples=['1000.witsml'], title='Name')
+    """
+    Optional, user-friendly file name.
+    """
+    FileSize: constr(pattern=r'^[0-9]+$') | None = Field(
+        None, examples=[95463], title='File Size'
+    )
+    """
+    Length of file in bytes. Implemented as string. The value must be convertible to a long integer (sizes can become very large).
+    """
+    EncodingFormatTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-EncodingFormatType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(
+        None,
+        examples=[
+            'namespace:reference-data--EncodingFormatType:application%2Fgeo%2Bjson:'
+        ],
+        title='Encoding Format Type ID',
+    )
+    """
+    Only used in FileCollection where the EncodingFormatType differs from data DatasetDefault specified in data.EncodingFormatTypeID: the media type specification for this dataset.
+    """
+    Checksum: constr(pattern=r'^([0-9a-fA-F]{2})+$') | None = Field(
+        None, examples=['d41d8cd98f00b204e9800998ecf8427e'], title='Checksum'
+    )
+    """
+    Checksum of file bytes - a hexadecimal number with even number of bytes.
+    """
+    ChecksumAlgorithm: str | None = Field(
+        None, examples=['SHA-256'], title='Checksum Algorithm'
+    )
+    """
+    The name of the checksum algorithm e.g. MD5, SHA-256.
+    """

osdu_models/abstract/abstract_file_source_info/v1_0_1.py

@@ -0,0 +1,92 @@
+# generated by datamodel-codegen:
+#   filename:  abstract/abstract_file_source_info/v1_0_1.json
+
+from __future__ import annotations
+from pydantic import BaseModel, ConfigDict, Field, constr
+
+
+class AbstractFileSourceInfo(BaseModel):
+    """
+    A schema fragment to describe file source information.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    FileSource: str = Field(
+        ...,
+        examples=['s3://default_bucket/r1/data/provided/documents/1000.witsml'],
+        title='File Source',
+    )
+    """
+    The location of the file. It can be a relative path. The actual access is provided via the File Service. When used in context of a FileCollection (dataset--FileCollection*) FileSource is a relative path from the FileCollectionPath. It can be used by consumers to pull an individual file if they so choose by concatenating the FileCollectionPath with the FileSource. This property is required.
+    """
+    PreloadFilePath: str | None = Field(
+        None,
+        examples=['s3://staging-area/r7/raw-data/provided/documents/1000.witsml'],
+        title='Preload File Path',
+    )
+    """
+    File system path to the data file as it existed before loading to the data platform.
+    """
+    PreloadFileCreateUser: str | None = Field(
+        None, examples=['somebody@acme.org'], title='Preload File Create User'
+    )
+    """
+    Optional user name or reference, who created the file prior to up-loading to the platform.
+    """
+    PreloadFileCreateDate: str | None = Field(
+        None, examples=['2019-12-16T11:46:20.163Z'], title='Preload File Create Date'
+    )
+    """
+    Optional create date and time of the file prior to up-loading to the platform.
+    """
+    PreloadFileModifyUser: str | None = Field(
+        None, examples=['somebody.else@acme.org'], title='Preload File Modify User'
+    )
+    """
+    Optional user name or reference, who last modified the file prior to up-loading to the platform.
+    """
+    PreloadFileModifyDate: str | None = Field(
+        None, examples=['2019-12-20T17:20:05.356Z'], title='Preload File Modify Date'
+    )
+    """
+    Optional last modified date and time of the file prior to up-loading to the platform.
+    """
+    Name: str | None = Field(None, examples=['1000.witsml'], title='Name')
+    """
+    Optional, user-friendly file name.
+    """
+    FileSize: constr(pattern=r'^[0-9]+$') | None = Field(
+        None, examples=['42949672960'], title='File Size'
+    )
+    """
+    Length of file in bytes. Implemented as string. The value must be convertible to a long integer (sizes can become very large).
+    """
+    EncodingFormatTypeID: (
+        constr(
+            pattern=r'^[\w\-\.]+:reference-data\-\-EncodingFormatType:[\w\-\.\:\%]+:[0-9]*$'
+        )
+        | None
+    ) = Field(
+        None,
+        examples=[
+            'namespace:reference-data--EncodingFormatType:application%2Fgeo%2Bjson:'
+        ],
+        title='Encoding Format Type ID',
+    )
+    """
+    Only used in FileCollection where the EncodingFormatType differs from data DatasetDefault specified in data.EncodingFormatTypeID: the media type specification for this dataset.
+    """
+    Checksum: constr(pattern=r'^([0-9a-fA-F]{2})+$') | None = Field(
+        None, examples=['d41d8cd98f00b204e9800998ecf8427e'], title='Checksum'
+    )
+    """
+    Checksum of file bytes - a hexadecimal number with even number of bytes.
+    """
+    ChecksumAlgorithm: str | None = Field(
+        None, examples=['SHA-256'], title='Checksum Algorithm'
+    )
+    """
+    The name of the checksum algorithm e.g. MD5, SHA-256.
+    """

osdu_models/abstract/abstract_fluid_additive/__init__.py

@@ -0,0 +1,2 @@
+# generated by datamodel-codegen:
+#   filename:  tmp4rfivwe4