Commit fbd032e0 authored by Niall McDaid's avatar Niall McDaid Committed by Niall McDaid
Browse files

Minor updates to README

parent 3071662b
...@@ -8,13 +8,14 @@ ...@@ -8,13 +8,14 @@
2. This is a wrapper behind the Wellbore DDMS [API](https://community.opengroup.org/osdu/platform/domain-data-mgmt-services/wellbore/wellbore-domain-services/-/blob/master/spec/generated/openapi.json) 2. This is a wrapper behind the Wellbore DDMS [API](https://community.opengroup.org/osdu/platform/domain-data-mgmt-services/wellbore/wellbore-domain-services/-/blob/master/spec/generated/openapi.json)
## Install from Package Registry ## Install from Package Registry
### Before installation: ### Before installation:
- Please ensure your Python version is 3.8 or newer and that Python has been added to the PATH (in your system's environment variables). - Ensure Python 3.8 or newer is installed and that Python has been added to the PATH (in your system's environment variables).
- Confirm you have `pip` installed by running the following command (it should be installed automatically when you installed Python) - `pip --version` - Confirm you have `pip` installed by running the following command (it should be installed automatically when you installed Python) - `pip --version`
- If installing `wbdutil` within a virtual environment, first install `pipenv` using the following command - `pip install pipenv` - If installing `wbdutil` within a virtual environment, first install `pipenv` using the following command - `pip install pipenv`
- Note: There is a bug in `pipenv` version 2021.11.23 which will cause the `wbdutil` installation command to fail. Ensure your version number is different to this (e.g. `pip install pipenv=="2021.11.15"`). - Note: There is a bug in `pipenv` version 2021.11.23 which will cause the `wbdutil` installation command to fail. Ensure your version number is different to this (e.g. `pip install pipenv=="2021.11.15"` or alternatively a newer version).
### Installation: ### Installation:
The simplest way to install `wbdutil` is from the community package registry. The simplest way to install `wbdutil` is from the community package registry.
...@@ -28,6 +29,7 @@ pip install wbdutil --extra-index-url https://community.opengroup.org/api/v4/pro ...@@ -28,6 +29,7 @@ pip install wbdutil --extra-index-url https://community.opengroup.org/api/v4/pro
pipenv install wbdutil --extra-index-url https://community.opengroup.org/api/v4/projects/801/packages/pypi/simple --skip-lock pipenv install wbdutil --extra-index-url https://community.opengroup.org/api/v4/projects/801/packages/pypi/simple --skip-lock
``` ```
## Usage ## Usage
The `wbdutil` package has a command line interface of the same name `wbdutil` which has the general syntax: The `wbdutil` package has a command line interface of the same name `wbdutil` which has the general syntax:
...@@ -45,10 +47,10 @@ There are several groups: ...@@ -45,10 +47,10 @@ There are several groups:
* `search`: Search for a wellbore given a well name. * `search`: Search for a wellbore given a well name.
* `update`: Update the existing bulk data for a given welllog * `update`: Update the existing bulk data for a given welllog
The `wbdutil` reads configuration information from a [configuration file](#config-file). The `wbdutil` requires configuration information, read from a [configuration file](#config-file).
The path to this file must either be provided in the environment variable `CONFIGPATH` or as a command line option. The path to this file must either be provided in the environment variable `CONFIGPATH` or as a command line option.
All the commands that connect to an OSDU instance require a bearer token. All the commands that connect to an OSDU instance (e.g. commands within the `ingest` group) require a bearer token.
This must be provided either in the environment variable `OSDUTOKEN` or as a command line option. This must be provided either in the environment variable `OSDUTOKEN` or as a command line option.
### Environment variables ### Environment variables
...@@ -56,12 +58,12 @@ This must be provided either in the environment variable `OSDUTOKEN` or as a com ...@@ -56,12 +58,12 @@ This must be provided either in the environment variable `OSDUTOKEN` or as a com
| Varaible name | overriding command option | Comment | | Varaible name | overriding command option | Comment |
| ------------- | --------------------------| ------- | | ------------- | --------------------------| ------- |
| OSDUTOKEN | `--token` `-t` | The JWT required to authenticate against an OSDU instance. | | OSDUTOKEN | `--token` `-t` | The JWT required to authenticate against an OSDU instance. |
| CONFIGPATH | `--config_path` `-c` | The path to the configuration file | | CONFIGPATH | `--config_path` `-c` | The path to the configuration file. |
### Config file ### Config file
The wbdutil requires a configuration file that has the following JSON structure: The `wbdutil` requires a configuration file that has the following JSON structure:
``` ```
{ {
"base_url": "https://osdu-ship.msft-osdu-test.org", "base_url": "https://osdu-ship.msft-osdu-test.org",
...@@ -82,4 +84,4 @@ The wbdutil requires a configuration file that has the following JSON structure: ...@@ -82,4 +84,4 @@ The wbdutil requires a configuration file that has the following JSON structure:
} }
``` ```
The `base_url`, `data_partition_id` and `acl_domain` must be correct for the OSDU instance you want to connect to. An example configuration file that is setup for the preship OSDU instance is given in `src/example_opendes_configuration.json`. The `base_url`, `data_partition_id` and `acl_domain` must be correct for the OSDU instance you want to connect to. An example configuration file that is setup for the pre-ship OSDU instance is given in [src/example_opendes_configuration.json](src/example_opendes_configuration.json).
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment