README.md

# LAS Loader utility for Wellbore DDMS

## :exclamation: This is currently in development

## Description

1. This will be the OSDU LAS loader utility to support Wellbore DDMS.

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)

## Development

The application uses a virtual environment managed by pipenv. To execute the application and run the tests you will need to install Python 3.9 and pipenv.
The source code and unit test are stored in the `src` folder.

To download the package dependencies for the virtual environment change to the src folder and run:

```
pipenv install --dev
```

To run the tests and flake8 linting:

```
pipenv run flake8
pipenv run pytest
```

Alternatively a shell in the virtual environment can be created by running:

```
pipenv shell
```

### Adding package dependencies

Package dependencies are added using the pipenv command. Dependencies required for only the unit tests should be added to the `[dev-packages]` of the `Pipfile` by using:

```
pipenv install --dev package_name
```

Production packages should be installed using:

```
pipenv install package_name
```

### Usage via the command line interface

To invoke the CLI using the virtual environment and from within the `src` folder:
```
pipenv run python -m lascli <group> <command> <options>
```
Available groups are `fileload` and `list`. Help can be obtained with the `-h` option.
```
pipenv run python -m lascli -h
pipenv run python -m lascli fileload -h
pipenv run python -m lascli fileload ingest -h
```