Skip to content

Commit 905102a

Browse files
committed
deploy: fa0e3ad
1 parent 810366b commit 905102a

114 files changed

Lines changed: 227 additions & 2114 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.buildinfo

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# Sphinx build info version 1
22
# This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
3-
config: 6b32d07c66623603a625c009bb3d642a
3+
config: 0c952dd6b85dcc82623e4361f94be90c
44
tags: 645f666f9bcd5a90fca523b33c5a78b7
-14 Bytes
Binary file not shown.

_modules/archivist/access_policies.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
</script>
1515

1616
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
17-
<title>archivist.access_policies &mdash; DATATRAILS v0.34.1 documentation</title>
17+
<title>archivist.access_policies &mdash; DATATRAILS v0.35.0 documentation</title>
1818
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=b86133f3" />
1919
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=e59714d7" />
2020
<link rel="stylesheet" type="text/css" href="../../_static/sg_gallery.css?v=d2d258e8" />
@@ -24,7 +24,7 @@
2424
<link rel="shortcut icon" href="../../_static/DataTrails_Favicon.png"/>
2525
<script src="../../_static/jquery.js?v=5d32c60e"></script>
2626
<script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
27-
<script src="../../_static/documentation_options.js?v=b49c7ffd"></script>
27+
<script src="../../_static/documentation_options.js?v=6131b1bd"></script>
2828
<script src="../../_static/doctools.js?v=9bcbadda"></script>
2929
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
3030
<script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>

_modules/archivist/appidp.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
</script>
1515

1616
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
17-
<title>archivist.appidp &mdash; DATATRAILS v0.34.1 documentation</title>
17+
<title>archivist.appidp &mdash; DATATRAILS v0.35.0 documentation</title>
1818
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=b86133f3" />
1919
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=e59714d7" />
2020
<link rel="stylesheet" type="text/css" href="../../_static/sg_gallery.css?v=d2d258e8" />
@@ -24,7 +24,7 @@
2424
<link rel="shortcut icon" href="../../_static/DataTrails_Favicon.png"/>
2525
<script src="../../_static/jquery.js?v=5d32c60e"></script>
2626
<script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
27-
<script src="../../_static/documentation_options.js?v=b49c7ffd"></script>
27+
<script src="../../_static/documentation_options.js?v=6131b1bd"></script>
2828
<script src="../../_static/doctools.js?v=9bcbadda"></script>
2929
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
3030
<script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>

_modules/archivist/applications.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
</script>
1515

1616
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
17-
<title>archivist.applications &mdash; DATATRAILS v0.34.1 documentation</title>
17+
<title>archivist.applications &mdash; DATATRAILS v0.35.0 documentation</title>
1818
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=b86133f3" />
1919
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=e59714d7" />
2020
<link rel="stylesheet" type="text/css" href="../../_static/sg_gallery.css?v=d2d258e8" />
@@ -24,7 +24,7 @@
2424
<link rel="shortcut icon" href="../../_static/DataTrails_Favicon.png"/>
2525
<script src="../../_static/jquery.js?v=5d32c60e"></script>
2626
<script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
27-
<script src="../../_static/documentation_options.js?v=b49c7ffd"></script>
27+
<script src="../../_static/documentation_options.js?v=6131b1bd"></script>
2828
<script src="../../_static/doctools.js?v=9bcbadda"></script>
2929
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
3030
<script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>

_modules/archivist/archivist.html

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
</script>
1515

1616
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
17-
<title>archivist.archivist &mdash; DATATRAILS v0.34.1 documentation</title>
17+
<title>archivist.archivist &mdash; DATATRAILS v0.35.0 documentation</title>
1818
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=b86133f3" />
1919
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=e59714d7" />
2020
<link rel="stylesheet" type="text/css" href="../../_static/sg_gallery.css?v=d2d258e8" />
@@ -24,7 +24,7 @@
2424
<link rel="shortcut icon" href="../../_static/DataTrails_Favicon.png"/>
2525
<script src="../../_static/jquery.js?v=5d32c60e"></script>
2626
<script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
27-
<script src="../../_static/documentation_options.js?v=b49c7ffd"></script>
27+
<script src="../../_static/documentation_options.js?v=6131b1bd"></script>
2828
<script src="../../_static/doctools.js?v=9bcbadda"></script>
2929
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
3030
<script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
@@ -98,7 +98,7 @@ <h1>Source code for archivist.archivist</h1><div class="highlight"><pre>
9898

9999
<span class="sd">The REST methods in this class should only be used directly when</span>
100100
<span class="sd">a CRUD endpoint for the specific type of entity is unavailable.</span>
101-
<span class="sd">Current CRUD endpoints are assets, events, locations, attachments.</span>
101+
<span class="sd">Current CRUD endpoints are assets, events, attachments.</span>
102102
<span class="sd">IAM subjects and IAM access policies.</span>
103103

104104
<span class="sd">Instantiation of this class encapsulates the URL and authentication</span>
@@ -116,7 +116,7 @@ <h1>Source code for archivist.archivist</h1><div class="highlight"><pre>
116116
<span class="sd"> max_time=300.0,</span>
117117
<span class="sd"> )</span>
118118

119-
<span class="sd"> The arch variable now has additional endpoints assets,events,locations,</span>
119+
<span class="sd"> The arch variable now has additional endpoints assets,events,</span>
120120
<span class="sd"> attachments, IAM subjects and IAM access policies documented elsewhere.</span>
121121

122122
<span class="sd">&quot;&quot;&quot;</span>
@@ -153,7 +153,6 @@ <h1>Source code for archivist.archivist</h1><div class="highlight"><pre>
153153
<span class="n">_parse_response</span><span class="p">,</span>
154154
<span class="p">)</span>
155155
<span class="kn">from</span><span class="w"> </span><span class="nn">.events</span><span class="w"> </span><span class="kn">import</span> <span class="n">_EventsRestricted</span>
156-
<span class="kn">from</span><span class="w"> </span><span class="nn">.locations</span><span class="w"> </span><span class="kn">import</span> <span class="n">_LocationsClient</span>
157156
<span class="kn">from</span><span class="w"> </span><span class="nn">.retry429</span><span class="w"> </span><span class="kn">import</span> <span class="n">retry_429</span>
158157
<span class="kn">from</span><span class="w"> </span><span class="nn">.runner</span><span class="w"> </span><span class="kn">import</span> <span class="n">_Runner</span>
159158
<span class="kn">from</span><span class="w"> </span><span class="nn">.subjects</span><span class="w"> </span><span class="kn">import</span> <span class="n">_SubjectsClient</span>
@@ -189,7 +188,6 @@ <h1>Source code for archivist.archivist</h1><div class="highlight"><pre>
189188
<span class="s2">&quot;attachments&quot;</span><span class="p">:</span> <span class="n">_AttachmentsClient</span><span class="p">,</span>
190189
<span class="s2">&quot;composite&quot;</span><span class="p">:</span> <span class="n">_CompositeClient</span><span class="p">,</span>
191190
<span class="s2">&quot;events&quot;</span><span class="p">:</span> <span class="n">_EventsRestricted</span><span class="p">,</span>
192-
<span class="s2">&quot;locations&quot;</span><span class="p">:</span> <span class="n">_LocationsClient</span><span class="p">,</span>
193191
<span class="s2">&quot;runner&quot;</span><span class="p">:</span> <span class="n">_Runner</span><span class="p">,</span>
194192
<span class="s2">&quot;subjects&quot;</span><span class="p">:</span> <span class="n">_SubjectsClient</span><span class="p">,</span>
195193
<span class="s2">&quot;tenancies&quot;</span><span class="p">:</span> <span class="n">_TenanciesClient</span><span class="p">,</span>
@@ -235,7 +233,6 @@ <h1>Source code for archivist.archivist</h1><div class="highlight"><pre>
235233
<span class="bp">self</span><span class="o">.</span><span class="n">attachments</span><span class="p">:</span> <span class="n">_AttachmentsClient</span>
236234
<span class="bp">self</span><span class="o">.</span><span class="n">composite</span><span class="p">:</span> <span class="n">_CompositeClient</span>
237235
<span class="bp">self</span><span class="o">.</span><span class="n">events</span><span class="p">:</span> <span class="n">_EventsRestricted</span>
238-
<span class="bp">self</span><span class="o">.</span><span class="n">locations</span><span class="p">:</span> <span class="n">_LocationsClient</span>
239236
<span class="bp">self</span><span class="o">.</span><span class="n">runner</span><span class="p">:</span> <span class="n">_Runner</span>
240237
<span class="bp">self</span><span class="o">.</span><span class="n">subjects</span><span class="p">:</span> <span class="n">_SubjectsClient</span>
241238
<span class="bp">self</span><span class="o">.</span><span class="n">tenancies</span><span class="p">:</span> <span class="n">_TenanciesClient</span>

_modules/archivist/assets.html

Lines changed: 3 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
</script>
1515

1616
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
17-
<title>archivist.assets &mdash; DATATRAILS v0.34.1 documentation</title>
17+
<title>archivist.assets &mdash; DATATRAILS v0.35.0 documentation</title>
1818
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=b86133f3" />
1919
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=e59714d7" />
2020
<link rel="stylesheet" type="text/css" href="../../_static/sg_gallery.css?v=d2d258e8" />
@@ -24,7 +24,7 @@
2424
<link rel="shortcut icon" href="../../_static/DataTrails_Favicon.png"/>
2525
<script src="../../_static/jquery.js?v=5d32c60e"></script>
2626
<script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
27-
<script src="../../_static/documentation_options.js?v=b49c7ffd"></script>
27+
<script src="../../_static/documentation_options.js?v=6131b1bd"></script>
2828
<script src="../../_static/doctools.js?v=9bcbadda"></script>
2929
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
3030
<script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
@@ -278,7 +278,7 @@ <h1>Source code for archivist.assets</h1><div class="highlight"><pre>
278278
<span class="bp">self</span><span class="p">,</span> <span class="n">data</span><span class="p">:</span> <span class="s2">&quot;dict[str, Any]&quot;</span><span class="p">,</span> <span class="o">*</span><span class="p">,</span> <span class="n">confirm</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span>
279279
<span class="p">)</span> <span class="o">-&gt;</span> <span class="s2">&quot;tuple[Asset, bool]&quot;</span><span class="p">:</span>
280280
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
281-
<span class="sd"> Creates an asset and associated locations and attachments if asset</span>
281+
<span class="sd"> Creates an asset and associated attachments if asset</span>
282282
<span class="sd"> does not already exist.</span>
283283

284284
<span class="sd"> Args:</span>
@@ -300,18 +300,6 @@ <h1>Source code for archivist.assets</h1><div class="highlight"><pre>
300300
<span class="sd"> arc_serial_number: das-j1-01</span>
301301
<span class="sd"> arc_description: Electronic door entry system to DataTrails France</span>
302302
<span class="sd"> wavestone_asset_id: paris.france.datatrails.das</span>
303-
<span class="sd"> location:</span>
304-
<span class="sd"> identity: locations/xxxxxxxxxxxxxxxxxxxxxxxxxx</span>
305-
<span class="sd"> location:</span>
306-
<span class="sd"> selector:</span>
307-
<span class="sd"> - display_name</span>
308-
<span class="sd"> display_name: DataTrails Paris</span>
309-
<span class="sd"> description: Sales and sales support for the French region</span>
310-
<span class="sd"> latitude: 48.8339211,</span>
311-
<span class="sd"> longitude: 2.371345,</span>
312-
<span class="sd"> attributes:</span>
313-
<span class="sd"> address: 5 Parvis Alan Turing, 75013 Paris, France</span>
314-
<span class="sd"> wavestone_ext: managed</span>
315303
<span class="sd"> attachments:</span>
316304
<span class="sd"> - filename: functests/test_resources/doors/assets/entry-terminal.jpg</span>
317305
<span class="sd"> content_type: image/jpg</span>
@@ -320,12 +308,6 @@ <h1>Source code for archivist.assets</h1><div class="highlight"><pre>
320308
<span class="sd"> The &#39;selector&#39; value is required and will usually specify the &#39;arc_display_name&#39; as a</span>
321309
<span class="sd"> secondary key. The keys in &#39;selector&#39; must exist in the attributes of the asset.</span>
322310

323-
<span class="sd"> If &#39;location&#39; is specified then the &#39;selector&#39; value is required and is used as a</span>
324-
<span class="sd"> secondary key. Likewise the secondary key must exist in the attributes of the location.</span>
325-
326-
<span class="sd"> Alternatively the identity of the location is specified - both</span>
327-
<span class="sd"> are shown - choose one.</span>
328-
329311
<span class="sd"> Returns:</span>
330312
<span class="sd"> tuple of :class:`Asset` instance, Boolean is True if asset already existed</span>
331313

@@ -335,7 +317,6 @@ <h1>Source code for archivist.assets</h1><div class="highlight"><pre>
335317
<span class="n">existed</span> <span class="o">=</span> <span class="kc">False</span>
336318
<span class="n">data</span> <span class="o">=</span> <span class="n">deepcopy</span><span class="p">(</span><span class="n">data</span><span class="p">)</span>
337319
<span class="n">attachments</span> <span class="o">=</span> <span class="n">data</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="s2">&quot;attachments&quot;</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
338-
<span class="n">location</span> <span class="o">=</span> <span class="n">data</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="s2">&quot;location&quot;</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
339320
<span class="n">selector</span> <span class="o">=</span> <span class="n">data</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="s2">&quot;selector&quot;</span><span class="p">)</span> <span class="c1"># must exist</span>
340321
<span class="n">props</span><span class="p">,</span> <span class="n">attrs</span> <span class="o">=</span> <span class="n">selector_signature</span><span class="p">(</span><span class="n">selector</span><span class="p">,</span> <span class="n">data</span><span class="p">)</span>
341322
<span class="k">try</span><span class="p">:</span>
@@ -350,16 +331,6 @@ <h1>Source code for archivist.assets</h1><div class="highlight"><pre>
350331
<span class="n">LOGGER</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s2">&quot;asset with selector </span><span class="si">%s</span><span class="s2">,</span><span class="si">%s</span><span class="s2"> already exists&quot;</span><span class="p">,</span> <span class="n">props</span><span class="p">,</span> <span class="n">attrs</span><span class="p">)</span>
351332
<span class="k">return</span> <span class="n">asset</span><span class="p">,</span> <span class="kc">True</span>
352333

353-
<span class="c1"># is location present?</span>
354-
<span class="k">if</span> <span class="n">location</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
355-
<span class="k">if</span> <span class="s2">&quot;identity&quot;</span> <span class="ow">in</span> <span class="n">location</span><span class="p">:</span>
356-
<span class="n">data</span><span class="p">[</span><span class="s2">&quot;attributes&quot;</span><span class="p">][</span><span class="s2">&quot;arc_home_location_identity&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="n">location</span><span class="p">[</span><span class="s2">&quot;identity&quot;</span><span class="p">]</span>
357-
<span class="k">else</span><span class="p">:</span>
358-
<span class="n">loc</span><span class="p">,</span> <span class="n">_</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_archivist</span><span class="o">.</span><span class="n">locations</span><span class="o">.</span><span class="n">create_if_not_exists</span><span class="p">(</span>
359-
<span class="n">location</span><span class="p">,</span>
360-
<span class="p">)</span>
361-
<span class="n">data</span><span class="p">[</span><span class="s2">&quot;attributes&quot;</span><span class="p">][</span><span class="s2">&quot;arc_home_location_identity&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="n">loc</span><span class="p">[</span><span class="s2">&quot;identity&quot;</span><span class="p">]</span>
362-
363334
<span class="c1"># any attachments ?</span>
364335
<span class="k">if</span> <span class="n">attachments</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
365336
<span class="k">for</span> <span class="n">a</span> <span class="ow">in</span> <span class="n">attachments</span><span class="p">:</span>

_modules/archivist/attachments.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
</script>
1515

1616
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
17-
<title>archivist.attachments &mdash; DATATRAILS v0.34.1 documentation</title>
17+
<title>archivist.attachments &mdash; DATATRAILS v0.35.0 documentation</title>
1818
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=b86133f3" />
1919
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=e59714d7" />
2020
<link rel="stylesheet" type="text/css" href="../../_static/sg_gallery.css?v=d2d258e8" />
@@ -24,7 +24,7 @@
2424
<link rel="shortcut icon" href="../../_static/DataTrails_Favicon.png"/>
2525
<script src="../../_static/jquery.js?v=5d32c60e"></script>
2626
<script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
27-
<script src="../../_static/documentation_options.js?v=b49c7ffd"></script>
27+
<script src="../../_static/documentation_options.js?v=6131b1bd"></script>
2828
<script src="../../_static/doctools.js?v=9bcbadda"></script>
2929
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
3030
<script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>

0 commit comments

Comments
 (0)