deploy: fe704bb

Author: ChainReaction31

.buildinfo

@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: 4a4f3fe1709d94529fc822bf7dc2d3bf
+tags: 645f666f9bcd5a90fca523b33c5a78b7

.doctrees/environment.pickle

@@ -0,0 +1,19 @@
+
+ConSys4Py Documentation
+=====================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   tutorials
+   pydocs
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

.doctrees/index.doctree

@@ -0,0 +1,7 @@
+ConSys4Py API Docs
+==================
+
+.. automodule:: consys4py
+    :members:
+    :undoc-members:
+    :show-inheritance:

.doctrees/pydocs.doctree

@@ -0,0 +1,115 @@
+Tutorials
+====================
+
+.. warning::
+
+    This is a work in progress, some features may change and packages may move or be removed
+    before the 1.0 release.
+
+Using the API
+============================
+There are three main ways to interact with the API
+
+1. Direct API calls
+-----------------------------------------
+In the modules for parts 1 and 2, there are separate files that represent the different parts of the API. These files
+contain methods for interacting with the remote server directly.
+
+2. Default API Helper
+-----------------------------------------
+Using the Default API helper allows for repeated calls to the same API server. This is useful when
+building a library on top of  this project.
+
+3. Custom API Requests
+-----------------------------------------
+If you need the most flexibility, you can create custom requests using the request builder and API helper objects
+
+.. note::
+
+    The following examples will not convert the responses back into Objects, but it is possible to do so
+    using the appropriate class's `model_validate` method on the response object's string representation.
+
+Interacting with Systems
+============================
+
+List Systems
+-----------------------------------------
+.. note::
+
+    Using a direct call from `Systems` file
+.. code-block:: python
+
+    from consys4py import Systems
+
+    Systems.list_all_systems(server_url)
+
+Retrieve Specific System
+-----------------------------------------
+
+.. code-block:: python
+
+    from consys4py import Systems
+
+    Systems.retrieve_system_by_id(server_url, system_id)
+
+Add/Create System
+-----------------------------------------
+The method for creating a new system does take a string or properly structured `dict`.
+For ease of use, the `SmlJSONBody` or `GeoJSONBody` can be used. They use Pydantic to validate the data.
+Just be sure to convert them to a JSON string before passing them to the `create_new_systems` method.
+
+.. code-block:: python
+
+    from consys4py import Systems
+
+    sml = SmlJSONBody(object_type='SimpleProcess', id=str(random.randint(1000, 9999)),
+                           description="A Test System inserted from the Python Connected Systems API Client",
+                           unique_id=f'urn:test:client:sml-single', label=f'Test System - SML Single',
+                           definition="http://test.com")
+
+    sml_as_str = sml.model_dump_json(exclude_none=True, by_alias=True)
+    Systems.create_new_systems(server_url, sml_as_str, uname="test", pword="test",
+                               headers=sml_json_headers)
+
+Datastreams and Observations
+============================
+
+Add a Datastream and Observation
+------------------------------------------------------------
+.. note::
+
+    This assumes that the user knows the system id and the datastream id
+
+.. code-block:: python
+
+    from consys4py import Datastreams
+
+    time_schema = TimeSchema(label="Test Datastream Time", definition="http://test.com/Time", name="timestamp",
+                             uom=URI(href="http://test.com/TimeUOM"))
+    bool_schema = BooleanSchema(label="Test Datastream Boolean", definition="http://test.com/Boolean",
+                                name="testboolean")
+    datarecord_schema = SWEDatastreamSchema(encoding=JSONEncoding(), obs_format=ObservationFormat.SWE_JSON.value,
+                                            record_schema=DataRecordSchema(label="Test Datastream Record",
+                                                                           definition="http://test.com/Record",
+                                                                           fields=[time_schema, bool_schema]))
+
+    datastream_body = DatastreamBodyJSON(name="Test Datastream", output_name="Test Output #1", datastream_schema=datarecord_schema)
+    temp_test_json = datastream_body.model_dump_json(exclude_none=True, by_alias=True)
+
+    resp = Datastreams.add_datastreams_to_system(server_url, retrieved_systems[1]['id'],
+                                                 datastream_body.model_dump_json(exclude_none=True, by_alias=True),
+                                                 headers=json_headers)
+
+    the_time = datetime.utcnow().isoformat() + 'Z'
+    time_millis = test_time_start.timestamp() * 1000
+
+    obs = ObservationOMJSONInline(phenomenon_time=the_time,
+                                  result_time=the_time,
+                                  result={
+                                      "timestamp": time_millis,
+                                      "testboolean": True
+                                  })
+    print(f'Observation: {obs.model_dump_json(exclude_none=True, by_alias=True)}')
+    resp = Observations.add_observations_to_datastream(server_url, ds_id,
+                                                       obs.model_dump_json(exclude_none=True, by_alias=True),
+                                                       headers=json_headers)

.doctrees/tutorials.doctree

@@ -0,0 +1,123 @@
+/* Compatability shim for jQuery and underscores.js.
+ *
+ * Copyright Sphinx contributors
+ * Released under the two clause BSD licence
+ */
+
+/**
+ * small helper function to urldecode strings
+ *
+ * See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/decodeURIComponent#Decoding_query_parameters_from_a_URL
+ */
+jQuery.urldecode = function(x) {
+    if (!x) {
+        return x
+    }
+    return decodeURIComponent(x.replace(/\+/g, ' '));
+};
+
+/**
+ * small helper function to urlencode strings
+ */
+jQuery.urlencode = encodeURIComponent;
+
+/**
+ * This function returns the parsed url parameters of the
+ * current request. Multiple values per key are supported,
+ * it will always return arrays of strings for the value parts.
+ */
+jQuery.getQueryParameters = function(s) {
+    if (typeof s === 'undefined')
+        s = document.location.search;
+    var parts = s.substr(s.indexOf('?') + 1).split('&');
+    var result = {};
+    for (var i = 0; i < parts.length; i++) {
+        var tmp = parts[i].split('=', 2);
+        var key = jQuery.urldecode(tmp[0]);
+        var value = jQuery.urldecode(tmp[1]);
+        if (key in result)
+            result[key].push(value);
+        else
+            result[key] = [value];
+    }
+    return result;
+};
+
+/**
+ * highlight a given string on a jquery object by wrapping it in
+ * span elements with the given class name.
+ */
+jQuery.fn.highlightText = function(text, className) {
+    function highlight(node, addItems) {
+        if (node.nodeType === 3) {
+            var val = node.nodeValue;
+            var pos = val.toLowerCase().indexOf(text);
+            if (pos >= 0 &&
+                !jQuery(node.parentNode).hasClass(className) &&
+                !jQuery(node.parentNode).hasClass("nohighlight")) {
+                var span;
+                var isInSVG = jQuery(node).closest("body, svg, foreignObject").is("svg");
+                if (isInSVG) {
+                    span = document.createElementNS("http://www.w3.org/2000/svg", "tspan");
+                } else {
+                    span = document.createElement("span");
+                    span.className = className;
+                }
+                span.appendChild(document.createTextNode(val.substr(pos, text.length)));
+                node.parentNode.insertBefore(span, node.parentNode.insertBefore(
+                    document.createTextNode(val.substr(pos + text.length)),
+                    node.nextSibling));
+                node.nodeValue = val.substr(0, pos);
+                if (isInSVG) {
+                    var rect = document.createElementNS("http://www.w3.org/2000/svg", "rect");
+                    var bbox = node.parentElement.getBBox();
+                    rect.x.baseVal.value = bbox.x;
+                    rect.y.baseVal.value = bbox.y;
+                    rect.width.baseVal.value = bbox.width;
+                    rect.height.baseVal.value = bbox.height;
+                    rect.setAttribute('class', className);
+                    addItems.push({
+                        "parent": node.parentNode,
+                        "target": rect});
+                }
+            }
+        }
+        else if (!jQuery(node).is("button, select, textarea")) {
+            jQuery.each(node.childNodes, function() {
+                highlight(this, addItems);
+            });
+        }
+    }
+    var addItems = [];
+    var result = this.each(function() {
+        highlight(this, addItems);
+    });
+    for (var i = 0; i < addItems.length; ++i) {
+        jQuery(addItems[i].parent).before(addItems[i].target);
+    }
+    return result;
+};
+
+/*
+ * backward compatibility for jQuery.browser
+ * This will be supported until firefox bug is fixed.
+ */
+if (!jQuery.browser) {
+    jQuery.uaMatch = function(ua) {
+        ua = ua.toLowerCase();
+
+        var match = /(chrome)[ \/]([\w.]+)/.exec(ua) ||
+            /(webkit)[ \/]([\w.]+)/.exec(ua) ||
+            /(opera)(?:.*version|)[ \/]([\w.]+)/.exec(ua) ||
+            /(msie) ([\w.]+)/.exec(ua) ||
+            ua.indexOf("compatible") < 0 && /(mozilla)(?:.*? rv:([\w.]+)|)/.exec(ua) ||
+            [];
+
+        return {
+            browser: match[ 1 ] || "",
+            version: match[ 2 ] || "0"
+        };
+    };
+    jQuery.browser = {};
+    jQuery.browser[jQuery.uaMatch(navigator.userAgent).browser] = true;
+}