OSDU
OSDU Data Platform
Domain Data Management Services
Wellbore
Wellbore Domain Services

Repository

OSDU_BASE_URL= ""
TOKEN= ""
curl -X 'GET' '$OSDU_BASE_URL/api/os-wellbore-ddms/version' -H 'Authorization: Bearer $TOKEN'

// Response
{
  "details": {
    ... Other properties before  ...
    "enable_wdms_bulk_worker": "True"  <======== If True, WDMS worker deployment is avaialble
  }
}
# Windows
python -m pip install --upgrade pip
python -m pip --version

# macOS and Linux
python3 -m pip install --upgrade pip
python3 -m pip --version
# Windows
python -m venv env

# macOS/Linux
python3 -m venv env
# Windows
.\env\Scripts\activate

# macOS/Linux
source env/bin/activate
pip install -r requirements.txt
pip install -r requirements.txt -r requirements_dev.txt
# Install test dependencies
pip install -r requirements.txt -r requirements_dev.txt

# run tests
python -m pytest --junit-xml=unit_tests_report.xml --cov=app --cov-report=html --cov-report=xml tests/unit
Using --randomly-seed=256596674
--randomly-seed=last
--randomly-seed=1234
-p no:randomly
@pytest.mark.slow
-m 'not serial and not slow"
-m 'serial'
-n auto -m "not serial"
-n 0 -m "serial"
mkdir -p tmpstorage tmpblob
python main.py -e USE_INTERNAL_STORAGE_SERVICE_WITH_PATH $(pwd)/tmpstorage -e USE_LOCALFS_BLOB_STORAGE_WITH_PATH $(pwd)/tmpblob -e CLOUD_PROVIDER local
cd tests/integration
python gen_postman_env.py --token $(pyjwt --key=secret encode email=nobody@example.com) --base_url "http://127.0.0.1:8080/api/os-wellbore-ddms" --cloud_provider "local" --data_partition "dummy"
pytest ./functional --environment="./generated/postman_environment.json" --filter-tag=basic -p no:randomly
# Directly with Python

# Run on specific port and enforce dev mode
python main.py --port MY_PORT --dev_mode 1
# With Uvicorn (package) into venv already activated

# Run on specific port
uvicorn app.wdms_app:wdms_app --port LOCAL_PORT
If host is `127.0.0.1` or `localhost`, the dev_mode is automatically set to True.
The only significant change if dev_mode is on, is that configuration errors at startup are logged but don’t prevent the service to run, and allow to override some implementations.
python main.py -e SERVICE_HOST_STORAGE https://api.example.com/storage -e SERVICE_HOST_SEARCH https://api.example.com/search-service -e SERVICE_HOST_SCHEMA https://api.example.com/schema
# Create temp storage folders
mkdir tmpstorage
mkdir tmpblob

# Set your repo path
path="C:/source"

python main.py -e USE_INTERNAL_STORAGE_SERVICE_WITH_PATH $path/os-wellbore-ddms/tmpstorage -e USE_LOCALFS_BLOB_STORAGE_WITH_PATH $path/os-wellbore-ddms/tmpblob
python main.py -e CLOUD_PROVIDER gc \
-e SERVICE_HOST_SEARCH search_host \
-e SERVICE_HOST_SCHEMA schema_host \
-e SERVICE_HOST_STORAGE storage_host
-e SERVICE_URL_PARTITION partition_url
{
  "projectId": {
    "sensitive": false,
    "value": "<gc-project-id>"
  },
  "wellbore-dms-bucket": {
    "sensitive": false,
    "value": "<gc-bucket-for-the-data-partition>"
  }
}
python main.py -e CLOUD_PROVIDER az \
-e AZ_AI_CONNECTION_STR connection_str \
-e SERVICE_HOST_SEARCH search_host \
-e SERVICE_HOST_SCHEMA schema_host \
-e SERVICE_HOST_STORAGE storage_host \
-e SERVICE_HOST_PARTITION partition_host \
-e KEYVAULT_URL keyvault_url \
-e USE_PARTITION_SERVICE disabled
python main.py -e CLOUD_PROVIDER aws \
-e SERVICE_HOST_SEARCH search_host \
-e SERVICE_HOST_SCHEMA schema_host \
-e SERVICE_HOST_STORAGE storage_host \
-e SERVICE_HOST_PARTITION partition_host
# Set IMAGE_TAG
IMAGE_TAG="os-wellbore-ddms:dev"

# Build Image
docker build -t=$IMAGE_TAG --rm . -f ./build/Dockerfile --build-arg PIP_WHEEL_DIR=python-packages
LOCAL_PORT=<local_port>
IMAGE_TAG=<image_name>

docker run -d -p $LOCAL_PORT:8080 -e CLOUD_PROVIDER=local -e USE_LOCALFS_BLOB_STORAGE_WITH_PATH="/tmp" -e USE_INTERNAL_STORAGE_SERVICE_WITH_PATH="/tmp" -e OS_WELLBORE_DDMS_DEV_MODE=True -e USE_PARTITION_SERVICE=disabled $IMAGE_TAG
docker logs CONTAINER_ID
pip-sync
pip-sync requirements.txt requirements_dev.txt
pip install -r requirements.txt -r requirements_dev.txt
pip-compile
pip-compile --upgrade-package fastapi