sumo-wrapper-python 1.0.7__tar.gz → 1.0.9__tar.gz

sumo_wrapper_python-1.0.9/.github/workflows/build_docs.yaml

@@ -0,0 +1,34 @@
+# Build the docs here, to show errors. 
+# The actual deployment of docs is configured in ReadTheDocs.org. 
+
+name: Build and deploy docs 
+
+on:
+  pull_request:
+    branches: [main]
+  push:
+    branches: [main]
+
+jobs:
+  build_pywheels:
+    name: Build docs with Python ${{ matrix.python-version }} on ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        python-version: ["3.10"]
+        os: [ubuntu-latest]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install and build docs
+        run: |
+          pip install pip -U && pip install wheel -U
+          pip install .[docs]
+          pip list
+          sphinx-build docs build/sphinx/html

{sumo-wrapper-python-1.0.7 → sumo_wrapper_python-1.0.9}/.github/workflows/linting.yml

@@ -11,9 +11,9 @@ jobs:
       matrix:
         python-version: ["3.8"]
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v3
+        uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
       - uses: psf/black@stable
@@ -26,9 +26,9 @@ jobs:
       matrix:
         python-version: ["3.8"]
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v3
+        uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
       - name: Install dependencies

{sumo-wrapper-python-1.0.7 → sumo_wrapper_python-1.0.9}/.github/workflows/publish_release.yml

@@ -13,9 +13,9 @@ jobs:
     environment: production
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
-      - uses: actions/setup-python@v4
+      - uses: actions/setup-python@v5
         with:
           python-version: "3.8"
 

{sumo-wrapper-python-1.0.7 → sumo_wrapper_python-1.0.9}/.github/workflows/pytest.yml

@@ -21,17 +21,17 @@ jobs:
       id-token: write
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - name: Azure Login
-        uses: Azure/login@v1
+        uses: Azure/login@v2
         with:
           client-id: f96c150d-cacf-4257-9cc9-54b2c68ec4ce
           tenant-id: 3aa4a235-b6e2-48d5-9195-7fcf05b459b0
           subscription-id: 87897772-fb27-495f-ae40-486a2df57baa
 
       - name: Set up Python
-        uses: actions/setup-python@v3
+        uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
 

{sumo-wrapper-python-1.0.7 → sumo_wrapper_python-1.0.9}/.gitignore

@@ -11,5 +11,4 @@ build
 .cache/
 /src/testing.py
 /docs/_build
-/docs/_static
 /src/sumo/wrapper/version.py

{sumo-wrapper-python-1.0.7 → sumo_wrapper_python-1.0.9}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: sumo-wrapper-python
-Version: 1.0.7
+Version: 1.0.9
 Summary: Python wrapper for the Sumo API
 Author: Equinor
 License:                                  Apache License
@@ -223,162 +223,17 @@ Requires-Dist: PyYAML; extra == "test"
 Provides-Extra: docs
 Requires-Dist: sphinx; extra == "docs"
 Requires-Dist: sphinx-rtd-theme; extra == "docs"
+Requires-Dist: autoapi; extra == "docs"
+Requires-Dist: sphinx-autodoc-typehints; extra == "docs"
+Requires-Dist: sphinxcontrib-apidoc; extra == "docs"
 
 # sumo-wrapper-python
 
-Python wrappers for Sumo APIs
+[![Documentation Status](https://readthedocs.org/projects/sumo-wrapper-python/badge/?version=latest)](https://sumo-wrapper-python.readthedocs.io/en/latest/?badge=latest)
 
-Want to contribute? Read our [contributing](./CONTRIBUTING.md) guidelines
+## Documentation and guidelines
+[sumo-wrapper-python documentation](https://sumo-wrapper-python.readthedocs.io/en/latest/)
 
-## Install:
+## Contribute
+[Contribution guidelines](./CONTRIBUTING.md)
 
-    pip install sumo-wrapper-python
-
-For internal Equinor users, this package is available through the Komodo
-distribution.
-
-# Table of contents
-
-- [sumo-wrapper-python](#sumo-wrapper-python)
-  - [Install:](#install)
-- [Table of contents](#table-of-contents)
-- [SumoClient](#sumoclient)
-    - [Initialization](#initialization)
-    - [Parameters](#parameters)
-          - [`token` logic](#token-logic)
-  - [Methods](#methods)
-    - [get(path, \*\*params)](#getpath-params)
-    - [post(path, json, blob, params)](#postpath-json-blob-params)
-    - [put(path, json, blob)](#putpath-json-blob)
-    - [delete(path)](#deletepath)
-  - [Async methods](#async-methods)
-
-# SumoClient
-
-A thin wrapper class for the Sumo API.
-
-### Initialization
-
-```python
-from sumo.wrapper import SumoClient
-
-sumo = SumoClient(env="dev")
-```
-
-### Parameters
-
-```python
-class SumoClient:
-    def __init__(
-        self,
-        env:str,
-        token:str=None,
-        interactive:bool=False,
-        verbosity:str="CRITICAL"
-    ):
-```
-
-- `env`: sumo environment
-- `token`: bearer token or refresh token
-- `interactive`: use interactive flow when authenticating
-- `verbosity`: "DEBUG", "INFO", "WARNING", "ERROR", "CRITICAL"
-
-###### `token` logic
-
-If an access token is provided in the `token` parameter, it will be used as long
-as it's valid. An error will be raised when it expires.
-
-If we are unable to decode the provided `token` as a JWT, we treat it as a
-refresh token and attempt to use it to retrieve an access token.
-
-If no `token` is provided, an authentication code flow/interactive flow is
-triggered to retrieve a token.
-
-## Methods
-
-`SumoClient` has one method for each HTTP-method that is used in the sumo-core
-API. See examples of how to use these methods below.
-
-All methods accepts a path argument. Path parameters can be interpolated into
-the path string. Example:
-
-```python
-object_id = "1234"
-
-# GET/objects('{obejctid}')
-sumo.get(f"/objects('{object_id}')")
-```
-
-### get(path, \*\*params)
-
-Performs a GET-request to sumo-core. Accepts query parameters as keyword
-arguments.
-
-```python
-# Retrieve userdata
-user_data = sumo.get("/userdata")
-
-# Search for objects
-results = sumo.get("/search",
-    query="class:surface",
-    size:3,
-    select=["_id"]
-)
-
-# Get object by id
-object_id = "159405ba-0046-b321-55ce-542f383ba5c7"
-
-obj = sumo.get(f"/objects('{object_id}')")
-```
-
-### post(path, json, blob, params)
-
-Performs a POST-request to sumo-core. Accepts json and blob, but not both at the
-same time.
-
-```python
-# Upload new parent object
-parent_object = sumo.post("/objects", json=parent_meta_data)
-
-# Upload child object
-parent_id = parent_object["_id"]
-
-child_object = sumo.post(f"/objects('{parent_id}')", json=child_meta_data)
-```
-
-### put(path, json, blob)
-
-Performs a PUT-request to sumo-core. Accepts json and blob, but not both at the
-same time.
-
-```python
-# Upload blob to child object
-child_id = child_object["_id"]
-
-sumo.put(f"/objects('{child_id}')/blob", blob=blob)
-```
-
-### delete(path)
-
-Performs a DELETE-request to sumo-core.
-
-```python
-# Delete blob
-sumo.delete(f"/objects('{child_id}')/blob")
-
-# Delete child object
-sumo.delete(f"/objects('{child_id}')")
-
-# Delete parent object
-sumo.delete(f"/objects('{parent_id}')")
-```
-
-## Async methods
-
-`SumoClient` also has *async* alternatives `get_async`, `post_async`, `put_async` and `delete_async`.
-These accept the same parameters as their synchronous counterparts, but have to be *awaited*.
-
-```python
-# Retrieve userdata
-user_data = await sumo.get_async("/userdata")
-```

sumo_wrapper_python-1.0.9/README.md

@@ -0,0 +1,10 @@
+# sumo-wrapper-python
+
+[![Documentation Status](https://readthedocs.org/projects/sumo-wrapper-python/badge/?version=latest)](https://sumo-wrapper-python.readthedocs.io/en/latest/?badge=latest)
+
+## Documentation and guidelines
+[sumo-wrapper-python documentation](https://sumo-wrapper-python.readthedocs.io/en/latest/)
+
+## Contribute
+[Contribution guidelines](./CONTRIBUTING.md)
+

sumo_wrapper_python-1.0.9/docs/_templates/layout.html

@@ -0,0 +1,17 @@
+{% extends "!layout.html" %}
+  {% block footer %} {{ super() }}
+
+  <style>
+    /* Sidebar header (and topbar for mobile) */
+    .wy-side-nav-search, .wy-nav-top {
+      background: #ff1243;
+    }
+    /* Sidebar */
+    .wy-nav-side {
+      background: #474747;
+    }
+    .wy-side-nav-search > div.version {
+      color: white;
+    }
+  </style>
+{% endblock %}

sumo_wrapper_python-1.0.9/docs/api.rst

@@ -0,0 +1,9 @@
+API
+===
+
+The details of classes and methods
+
+.. automodule:: sumo.wrapper.sumo_client
+   :members:
+   :undoc-members:
+   :show-inheritance:

{sumo-wrapper-python-1.0.7 → sumo_wrapper_python-1.0.9}/docs/conf.py

@@ -13,14 +13,14 @@
 import os
 import sys
 
-sys.path.insert(0, os.path.abspath('../src/'))
+sys.path.insert(0, os.path.abspath("../src/"))
 
 
 # -- Project information -----------------------------------------------------
 
-project = 'sumo-wrapper-python'
-copyright = '2022, Sudo Team @ Equinor'
-author = 'Sudo Team @ Equinor'
+project = "sumo-wrapper-python"
+copyright = "2024, Sudo Team @ Equinor"
+author = "Sudo Team @ Equinor"
 
 
 # -- General configuration ---------------------------------------------------
@@ -28,15 +28,18 @@ author = 'Sudo Team @ Equinor'
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = ['sphinx.ext.napoleon', 'sphinx.ext.autodoc']
+extensions = [
+    "sphinx.ext.napoleon",
+    "sphinx.ext.autodoc",
+]
 
 # Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
+templates_path = ["_templates"]
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This pattern also affects html_static_path and html_extra_path.
-exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
 
 
 # -- Options for HTML output -------------------------------------------------
@@ -44,13 +47,12 @@ exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = 'sphinx_rtd_theme'
+html_theme = "sphinx_rtd_theme"
+html_logo = "_static/equinor-logo2.jpg"
 
-html_theme_options = {
-    "style_nav_header_background": "#C0C0C0",
-}
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+html_static_path = ["_static"]
+

{sumo-wrapper-python-1.0.7 → sumo_wrapper_python-1.0.9}/docs/index.rst

@@ -3,22 +3,13 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-sumo-wrapper-python
-===================
+Welcome to sumo-wrapper-python's documentation!
+===============================================
 
 .. toctree::
    :maxdepth: 2
    :caption: Contents:
 
-.. automodule:: sumo.wrapper.sumo_client
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-..
-   Indices and tables
-   ==================
-
-   * :ref:`genindex`
-   * :ref:`modindex`
-   * :ref:`search`
+   self
+   sumo-wrapper-python
+   api

sumo_wrapper_python-1.0.9/docs/sumo-wrapper-python.rst

@@ -0,0 +1,129 @@
+sumo-wrapper-python
+###################
+
+Short introduction
+*******************
+
+A thin python wrapper class that can be used by Sumo client applications to 
+communicate with the Sumo core server. It has methods for GET, PUT, POST and DELETE, 
+and handles authentication and automatic network retries. 
+
+This is low-level and close to the Sumo API and primarily intended for developers. 
+For usage in the FMU context, the higher-level alternative 
+`fmu-sumo <https://fmu-sumo.readthedocs.io>`_ is recommended. 
+
+The Sumo API is described at 
+`https://main-sumo-prod.radix.equinor.com/swagger-ui/ <https://main-sumo-prod.radix.equinor.com/swagger-ui/>`_
+
+The data model and schema is described at 
+`https://fmu-dataio.readthedocs.io/en/latest/datamodel.html <https://fmu-dataio.readthedocs.io/en/latest/datamodel.html>`_
+
+Information on Sumo can be found `here <https://doc-sumo-doc-prod.radix.equinor.com/>`_
+
+Preconditions
+*************
+
+Access
+------
+
+For internal Equinor users: Apply for access to Sumo in Equinor AccessIT, search for Sumo.
+
+Install
+*******
+
+For internal Equinor users, this package is included in the Komodo distribution. 
+For other use cases it can be pip installed directly from PyPI:
+
+.. code-block:: 
+
+   pip install sumo-wrapper-python
+
+Initialization
+**************
+
+.. code-block:: python
+
+   from sumo.wrapper import SumoClient
+
+   Sumo = SumoClient()
+
+`token` logic
+*************
+
+No token provided: this will trigger 
+an authentication process and then handles token, token refresh and
+re-authentication as automatic as possible. This would be the most common
+usecase. 
+
+If an access token is provided in the `token` parameter, it will be used as long
+as it's valid. An error will be raised when it expires.
+
+If we are unable to decode the provided `token` as a JWT, we treat it as a
+refresh token and attempt to use it to retrieve an access token.
+
+
+Methods
+*******
+
+`SumoClient` has one method for each HTTP-method that is used in the Sumo
+API: GET, PUT, POST and DELETE. In addition a method to get a blob client 
+which handles blob contents. 
+
+The methods accepts a path argument.  A path is the path to a 
+Sumo `API <https://main-sumo-prod.radix.equinor.com/swagger-ui/>`_ method, for 
+example "/search" or "/smda/countries". Path parameters can be added into
+the path string, for example 
+
+.. code-block:: python
+
+   f"/objects('{case_uuid}')/search"
+
+The Sumo API documentation is available from the Swagger button in 
+the Sumo frontend, or you can use this link:
+`https://main-sumo-prod.radix.equinor.com/swagger-ui/ <https://main-sumo-prod.radix.equinor.com/swagger-ui/>`_. 
+
+Async methods
+*************
+
+`SumoClient` also has *async* alternatives `get_async`, `post_async`, `put_async` and `delete_async`.
+These accept the same parameters as their synchronous counterparts, but have to be *awaited*.
+
+Usage and examples
+******************
+
+.. code-block:: python
+
+   from sumo.wrapper import SumoClient
+   sumo = SumoClient()
+
+   # The line above will trigger the authentication process, and 
+   # the behaviour depends on how long since your last login. 
+   # It could re-use existing login or it could take you through 
+   # a full Microsoft authentication process including  
+   # username, password, two-factor. 
+
+
+   # List your Sumo permissions:
+   print("My permissions:", sumo.get("/userpermissions").json())
+
+   # Get the first case from the list of cases you have access to:
+   case = sumo.get("/searchroot").json()["hits"]["hits"][0]
+   print("Case metadata:", case["_source"])
+   case_uuid = case["_source"]["fmu"]["case"]["uuid"]
+   print("Case uuid: ", case_uuid)
+
+   # Get the first child object:
+   child = sumo.get(f"/objects('{case_uuid}')/search").json()["hits"]["hits"][0]
+   print("Child metadata", child["_source"])
+   child_uuid = child["_id"]
+   print("Child uuid: ", child_uuid)
+
+   # Get the binary of the child
+   binary_object = sumo.get(f"/objects('{child_uuid}')/blob").content
+   print("Size of child binary object:", len(binary_object))
+
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+

{sumo-wrapper-python-1.0.7 → sumo_wrapper_python-1.0.9}/pyproject.toml

@@ -32,7 +32,13 @@ dependencies = [
 
 [project.optional-dependencies]
 test = ["pytest", "PyYAML"]
-docs = ["sphinx", "sphinx-rtd-theme"]
+docs = [
+  "sphinx",
+  "sphinx-rtd-theme",
+  "autoapi",
+  "sphinx-autodoc-typehints",
+  "sphinxcontrib-apidoc",
+]
 
 [project.urls]
 Repository = "https://github.com/equinor/sumo-wrapper-python"