Commit 0149e806 authored by Gregory Harris's avatar Gregory Harris
Browse files

Update the readme with install and deploy instructions.

parent d108c39c
Pipeline #77093 passed with stages
in 1 minute and 10 seconds
......@@ -8,6 +8,32 @@
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
The simplest way to install `lasloader` is from the community package registry. If you have `pip` installed simply run:
```
pip install lasloader --extra-index-url https://community.opengroup.org/api/v4/projects/801/packages/pypi/simple
```
This will download and install `lasloader` on your machine.
## Usage
The `lasloader` package has a command line interface called `lascli` which has the general syntax:
```
lascli <group> <command> options
```
Help for any group or command can be obtained by using the `-h` option.
There are several groups:
* `download`: Download a welllog and curve data to a las format file.
* `fileload`: Dry run of the ingest command, instead of uploading data to the OSDU instance it creates json files for the wellbore and welllog.
* `ingest`: Upload a wellbore, welllog and/or bulk data to an OSDU instance
* `list`: List the data held in OSDU for a given wellbore or welllog id.
* `search`: Search for a wellbore given a well name.
* `update`: Update the existing bulk data for a given welllog
## 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.
......@@ -103,41 +129,15 @@ This installs the package in a virtual environment. The CLI can then be run usin
pipenv run lascli
```
### Creating distribution archives
To create a distribution run:
```
python setup.py sdist bdist_wheel
```
This will create both source and binary wheel distributions. The package can then be deployed using:
```
pip install .
```
### Publish the package distribution
In order to publish the package you will need to create an access token in the open group community gitlab. Then add the following lines to the `~.pypirc` file.
### Publish to the Package Registry
```
[distutils]
index-servers =
opengroup
[opengroup]
repository = https://community.opengroup.org/api/v4/projects/801/packages/pypi
username = <token-name>
password = <token>
```
Now install twine for package upload:
```
pip install twine
```
Packages are published to the community package registry via the CI pipeline. Package publish is a manually triggered job. To run it navigate to the CI/CD jobs page of the `lasloader` module:
[https://community.opengroup.org/osdu/platform/data-flow/data-loading/wellbore-ddms-las-loader/-/jobs](https://community.opengroup.org/osdu/platform/data-flow/data-loading/wellbore-ddms-las-loader/-/jobs).
Now you are ready to upload the source and binary distributions, publish using:
python -m twine upload --verbose --repository opengroup dist/*
Run the publish job for the build you want to publish. It will build and upload `lasloader` with a specific package version number. The package version number is the `__VERSION__` found in the `__init__.py` file for the module followed by a build tag. The build tag is based upon the CI build_id:
1. The default build tag is an alpha release of the form 1.2.3a456
1. If the repo branch has been tagged wit a string starting wih `BETA` then the beta release form is used 1.2.3b456.
1. If the repo branch has been tagged wit a string starting wih `RELEASE` then the primary release form is used 1.2.3.456.
## Config file
......
Markdown is supported
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