Skip to content

Commit d3b58f1

Browse files
Update README with information on how to add the wrapper to Komodo.
1 parent a4b0bbc commit d3b58f1

1 file changed

Lines changed: 52 additions & 0 deletions

File tree

README.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,3 +8,55 @@ Development of Python wrappers for Sumo APIs
88

99
## Example code:
1010
[test_call_sumo_surface_api](scripts/examples/test_call_sumo_surface_api.py)
11+
12+
## Making it available in Komodo (Bleeding)
13+
The wrapper and the uploader (https://github.com/equinor/fmu-sumo) are intended to be used by the Equinor community to upload, search, and delete data to/from SUMO. To make them accessable for our community, they should be available as a komodo distribution (https://github.com/equinor/komodo-releases).
14+
15+
In order to do so, we should follow these steps:
16+
17+
### 1) Clone the Komodo repository and, from the master branch, create a new feature branch
18+
https://github.com/equinor/komodo-releases
19+
20+
### 2) Edit the file package_status.yml and add/modify the package information
21+
For Example:
22+
sumo-wrapper-python:
23+
visibility: public
24+
maturity: experimental
25+
importance: low
26+
27+
The package name must correspond to the name of the package's repository.
28+
29+
### 3) Edit the file repository.yml and add/modify the package information
30+
Example:
31+
sumo-wrapper-python:
32+
v0.1.0:
33+
source: https://0c0b51dd4ca3c035c04c01dd74216c2ec6c1648b@github.com/equinor/sumo-wrapper-python.git
34+
fetch: git
35+
make: sh
36+
makefile: setup-py.sh
37+
maintainer: rgarc
38+
depends:
39+
- PyYAML
40+
- msal
41+
- requests
42+
- python
43+
- setuptools
44+
45+
Again, the package name must correspond to the repository's name.
46+
47+
The second line corresponds to the current release tag for the package.
48+
49+
The source is the link for the repo + the PAT belonging to a bot user we set so we don't need to publish our own authentication (https://github.com/sumo-machine-user)
50+
51+
On the depends item, you should add the dependencies that must be installed in order to run the package. Note that dependecies already included in the standard library (e.g., the math library) don't need to be mentioned.
52+
53+
### 4) Edit the releases/matrices/bleeding.yml file and add/modify the package information
54+
Example:
55+
sumo-wrapper-python: v0.1.0
56+
57+
In this file, you only need to add the repository's name and the current release tag. Note that this is for bleeding distribution (unstable). For adding to a more stable distribution, this edit should go to another file in this folder (but that would probably require input from the komodo team).
58+
59+
### 5) Create a Pull Request
60+
Once you finish the edits, just push your branch with the changes and create a PR. The komodo team will then review it and merge it or give some feedback (you don't need to add reviewers nor merge with the master branch yourself).
61+
62+
For more information, you should contact the komodo team on the komodo/komodo-maintainers channel on Slack.

0 commit comments

Comments
 (0)