Auto-update from Github Actions Workflow

Deployed from commit c18d1dc (refs/heads/master)

Deployed from commit c9d8248 (refs/heads/master)

master/.buildinfo

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

master/_sources/upcoming_release_notes/318-mnt_mongo_backend.rst.txt

@@ -0,0 +1,22 @@
+318 mnt_mongo_backend
+#####################
+
+API Changes
+-----------
+- N/A
+
+Features
+--------
+- N/A
+
+Bugfixes
+--------
+- N/A
+
+Maintenance
+-----------
+- Update mongo backend to handle authSource, require connection information (host, user, etc)
+
+Contributors
+------------
+- tangkong

master/_sources/upcoming_release_notes/320-bug_update_json.rst.txt

@@ -0,0 +1,22 @@
+320 bug_update_json
+###################
+
+API Changes
+-----------
+- N/A
+
+Features
+--------
+- N/A
+
+Bugfixes
+--------
+- N/A
+
+Maintenance
+-----------
+- Allow `happi update` to handle json-backend-type payloads
+
+Contributors
+------------
+- tangkong

master/_static/documentation_options.js

@@ -1,6 +1,6 @@
 var DOCUMENTATION_OPTIONS = {
     URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
-    VERSION: '2.2.1.dev36+gee68d81',
+    VERSION: '2.3.1.dev10+gc9d8248',
     LANGUAGE: 'en',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',

master/api.html

@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Happi API &mdash; Happi 2.2.1.dev36+gee68d81 documentation</title>
+  <title>Happi API &mdash; Happi 2.3.1.dev10+gc9d8248 documentation</title>
       <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
   <!--[if lt IE 9]>
@@ -35,7 +35,7 @@
             Happi
           </a>
               <div class="version">
-                2.2.1.dev36+gee68d81
+                2.3.1.dev10+gc9d8248
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
@@ -652,7 +652,7 @@ <h2>Backends<a class="headerlink" href="#backends" title="Permalink to this head
 
 <table class="autosummary longtable docutils align-default">
 <tbody>
-<tr class="row-odd"><td><p><a class="reference internal" href="generated/happi.backends.mongo_db.MongoBackend.html#happi.backends.mongo_db.MongoBackend" title="happi.backends.mongo_db.MongoBackend"><code class="xref py py-obj docutils literal notranslate"><span class="pre">happi.backends.mongo_db.MongoBackend</span></code></a>([host, ...])</p></td>
+<tr class="row-odd"><td><p><a class="reference internal" href="generated/happi.backends.mongo_db.MongoBackend.html#happi.backends.mongo_db.MongoBackend" title="happi.backends.mongo_db.MongoBackend"><code class="xref py py-obj docutils literal notranslate"><span class="pre">happi.backends.mongo_db.MongoBackend</span></code></a>(host, ...)</p></td>
 <td><p>Abstraction for MongoDB backend.</p></td>
 </tr>
 <tr class="row-even"><td><p><a class="reference internal" href="generated/happi.backends.json_db.JSONBackend.html#happi.backends.json_db.JSONBackend" title="happi.backends.json_db.JSONBackend"><code class="xref py py-obj docutils literal notranslate"><span class="pre">happi.backends.json_db.JSONBackend</span></code></a>(path[, ...])</p></td>

master/cli.html

@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Command Line Interface &mdash; Happi 2.2.1.dev36+gee68d81 documentation</title>
+  <title>Command Line Interface &mdash; Happi 2.3.1.dev10+gc9d8248 documentation</title>
       <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
   <!--[if lt IE 9]>
@@ -35,7 +35,7 @@
             Happi
           </a>
               <div class="version">
-                2.2.1.dev36+gee68d81
+                2.3.1.dev10+gc9d8248
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
@@ -494,6 +494,39 @@ <h3>transfer<a class="headerlink" href="#happi-transfer" title="Permalink to thi
 <section id="happi-update">
 <h3>update<a class="headerlink" href="#happi-update" title="Permalink to this heading"></a></h3>
 <p>Update happi db with JSON_DATA payload.</p>
+<p>To use, either use command substitution:</p>
+<blockquote>
+<div><p>$ happi update $(cat my.json)</p>
+</div></blockquote>
+<p>Or pipe the JSON payload with <code class="xref any docutils literal notranslate"><span class="pre">-</span></code> as an argument:</p>
+<blockquote>
+<div><p>$ cat my.json | happi update -</p>
+</div></blockquote>
+<p>JSON payloads should be a list of items (dictionaries), with at least the
+“_id” and “type” keys.  eg:</p>
+<div class="line-block">
+<div class="line">[{</div>
+<div class="line-block">
+<div class="line">“_id”: “my_device”,</div>
+<div class="line">&lt;…&gt;</div>
+<div class="line">“type”: “mydevicelibrary.MyDevice”</div>
+</div>
+<div class="line">}]</div>
+</div>
+<p>Or a valid happi json database.  eg:</p>
+<div class="line-block">
+<div class="line">{</div>
+<div class="line-block">
+<div class="line">“my_device”: {</div>
+<div class="line-block">
+<div class="line">“_id”: “my_device”,</div>
+<div class="line">&lt;…&gt;</div>
+<div class="line">“type”: “mydevicelibrary.MyDevice”</div>
+</div>
+<div class="line">}</div>
+</div>
+<div class="line">}</div>
+</div>
 <div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>happi<span class="w"> </span>update<span class="w"> </span><span class="o">[</span>OPTIONS<span class="o">]</span><span class="w"> </span><span class="o">[</span>JSON_DATA<span class="o">]</span>...
 </pre></div>
 </div>

master/client.html

@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Using the Client &mdash; Happi 2.2.1.dev36+gee68d81 documentation</title>
+  <title>Using the Client &mdash; Happi 2.3.1.dev10+gc9d8248 documentation</title>
       <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
   <!--[if lt IE 9]>
@@ -35,7 +35,7 @@
             Happi
           </a>
               <div class="version">
-                2.2.1.dev36+gee68d81
+                2.3.1.dev10+gc9d8248
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
@@ -191,16 +191,16 @@ <h2>Searching the Database<a class="headerlink" href="#searching-the-database" t
 <span class="go"># All of the database entries as SearchResults:</span>
 <span class="gp">In [13]: </span><span class="nb">list</span><span class="p">(</span><span class="n">client</span><span class="o">.</span><span class="n">values</span><span class="p">())</span>
 <span class="gh">Out[13]: </span>
-<span class="go">[SearchResult(client=&lt;happi.client.Client object at 0x7f8be1252100&gt;, metadata={&#39;name&#39;: &#39;my_device&#39;, &#39;device_class&#39;: &#39;types.SimpleNamespace&#39;, &#39;args&#39;: [], &#39;kwargs&#39;: {}, &#39;active&#39;: True, &#39;documentation&#39;: None, &#39;_id&#39;: &#39;my_device&#39;, &#39;creation&#39;: &#39;Fri Jun 30 20:49:52 2023&#39;, &#39;last_edit&#39;: &#39;Fri Jun 30 20:49:52 2023&#39;, &#39;position&#39;: 345.5, &#39;type&#39;: &#39;HappiItem&#39;}),</span>
-<span class="go"> SearchResult(client=&lt;happi.client.Client object at 0x7f8be1252100&gt;, metadata={&#39;name&#39;: &#39;my_device2&#39;, &#39;device_class&#39;: &#39;types.SimpleNamespace&#39;, &#39;args&#39;: [], &#39;kwargs&#39;: {}, &#39;active&#39;: True, &#39;documentation&#39;: None, &#39;_id&#39;: &#39;my_device2&#39;, &#39;creation&#39;: &#39;Fri Jun 30 20:49:52 2023&#39;, &#39;last_edit&#39;: &#39;Fri Jun 30 20:49:52 2023&#39;, &#39;position&#39;: 355.5, &#39;type&#39;: &#39;HappiItem&#39;})]</span>
+<span class="go">[SearchResult(client=&lt;happi.client.Client object at 0x7f49ab3d9610&gt;, metadata={&#39;name&#39;: &#39;my_device&#39;, &#39;device_class&#39;: &#39;types.SimpleNamespace&#39;, &#39;args&#39;: [], &#39;kwargs&#39;: {}, &#39;active&#39;: True, &#39;documentation&#39;: None, &#39;_id&#39;: &#39;my_device&#39;, &#39;creation&#39;: &#39;Thu Jul 27 16:03:43 2023&#39;, &#39;last_edit&#39;: &#39;Thu Jul 27 16:03:43 2023&#39;, &#39;position&#39;: 345.5, &#39;type&#39;: &#39;HappiItem&#39;}),</span>
+<span class="go"> SearchResult(client=&lt;happi.client.Client object at 0x7f49ab3d9610&gt;, metadata={&#39;name&#39;: &#39;my_device2&#39;, &#39;device_class&#39;: &#39;types.SimpleNamespace&#39;, &#39;args&#39;: [], &#39;kwargs&#39;: {}, &#39;active&#39;: True, &#39;documentation&#39;: None, &#39;_id&#39;: &#39;my_device2&#39;, &#39;creation&#39;: &#39;Thu Jul 27 16:03:43 2023&#39;, &#39;last_edit&#39;: &#39;Thu Jul 27 16:03:43 2023&#39;, &#39;position&#39;: 355.5, &#39;type&#39;: &#39;HappiItem&#39;})]</span>
 
 <span class="go"># Pairs of (name, SearchResult):</span>
 <span class="gp">In [14]: </span><span class="nb">list</span><span class="p">(</span><span class="n">client</span><span class="o">.</span><span class="n">items</span><span class="p">())</span>
 <span class="gh">Out[14]: </span>
 <span class="go">[(&#39;my_device&#39;,</span>
-<span class="go">  SearchResult(client=&lt;happi.client.Client object at 0x7f8be1252100&gt;, metadata={&#39;name&#39;: &#39;my_device&#39;, &#39;device_class&#39;: &#39;types.SimpleNamespace&#39;, &#39;args&#39;: [], &#39;kwargs&#39;: {}, &#39;active&#39;: True, &#39;documentation&#39;: None, &#39;_id&#39;: &#39;my_device&#39;, &#39;creation&#39;: &#39;Fri Jun 30 20:49:52 2023&#39;, &#39;last_edit&#39;: &#39;Fri Jun 30 20:49:52 2023&#39;, &#39;position&#39;: 345.5, &#39;type&#39;: &#39;HappiItem&#39;})),</span>
+<span class="go">  SearchResult(client=&lt;happi.client.Client object at 0x7f49ab3d9610&gt;, metadata={&#39;name&#39;: &#39;my_device&#39;, &#39;device_class&#39;: &#39;types.SimpleNamespace&#39;, &#39;args&#39;: [], &#39;kwargs&#39;: {}, &#39;active&#39;: True, &#39;documentation&#39;: None, &#39;_id&#39;: &#39;my_device&#39;, &#39;creation&#39;: &#39;Thu Jul 27 16:03:43 2023&#39;, &#39;last_edit&#39;: &#39;Thu Jul 27 16:03:43 2023&#39;, &#39;position&#39;: 345.5, &#39;type&#39;: &#39;HappiItem&#39;})),</span>
 <span class="go"> (&#39;my_device2&#39;,</span>
-<span class="go">  SearchResult(client=&lt;happi.client.Client object at 0x7f8be1252100&gt;, metadata={&#39;name&#39;: &#39;my_device2&#39;, &#39;device_class&#39;: &#39;types.SimpleNamespace&#39;, &#39;args&#39;: [], &#39;kwargs&#39;: {}, &#39;active&#39;: True, &#39;documentation&#39;: None, &#39;_id&#39;: &#39;my_device2&#39;, &#39;creation&#39;: &#39;Fri Jun 30 20:49:52 2023&#39;, &#39;last_edit&#39;: &#39;Fri Jun 30 20:49:52 2023&#39;, &#39;position&#39;: 355.5, &#39;type&#39;: &#39;HappiItem&#39;}))]</span>
+<span class="go">  SearchResult(client=&lt;happi.client.Client object at 0x7f49ab3d9610&gt;, metadata={&#39;name&#39;: &#39;my_device2&#39;, &#39;device_class&#39;: &#39;types.SimpleNamespace&#39;, &#39;args&#39;: [], &#39;kwargs&#39;: {}, &#39;active&#39;: True, &#39;documentation&#39;: None, &#39;_id&#39;: &#39;my_device2&#39;, &#39;creation&#39;: &#39;Thu Jul 27 16:03:43 2023&#39;, &#39;last_edit&#39;: &#39;Thu Jul 27 16:03:43 2023&#39;, &#39;position&#39;: 355.5, &#39;type&#39;: &#39;HappiItem&#39;}))]</span>
 </pre></div>
 </div>
 <p>You could, for example, grab the first key by name and access it using
@@ -211,7 +211,7 @@ <h2>Searching the Database<a class="headerlink" href="#searching-the-database" t
 <span class="gh">Out[16]: </span><span class="go">&#39;my_device&#39;</span>
 
 <span class="gp">In [17]: </span><span class="n">client</span><span class="p">[</span><span class="n">key_0</span><span class="p">]</span>
-<span class="gh">Out[17]: </span><span class="go">SearchResult(client=&lt;happi.client.Client object at 0x7f8be1252100&gt;, metadata={&#39;name&#39;: &#39;my_device&#39;, &#39;device_class&#39;: &#39;types.SimpleNamespace&#39;, &#39;args&#39;: [], &#39;kwargs&#39;: {}, &#39;active&#39;: True, &#39;documentation&#39;: None, &#39;_id&#39;: &#39;my_device&#39;, &#39;creation&#39;: &#39;Fri Jun 30 20:49:52 2023&#39;, &#39;last_edit&#39;: &#39;Fri Jun 30 20:49:52 2023&#39;, &#39;position&#39;: 345.5, &#39;type&#39;: &#39;HappiItem&#39;})</span>
+<span class="gh">Out[17]: </span><span class="go">SearchResult(client=&lt;happi.client.Client object at 0x7f49ab3d9610&gt;, metadata={&#39;name&#39;: &#39;my_device&#39;, &#39;device_class&#39;: &#39;types.SimpleNamespace&#39;, &#39;args&#39;: [], &#39;kwargs&#39;: {}, &#39;active&#39;: True, &#39;documentation&#39;: None, &#39;_id&#39;: &#39;my_device&#39;, &#39;creation&#39;: &#39;Thu Jul 27 16:03:43 2023&#39;, &#39;last_edit&#39;: &#39;Thu Jul 27 16:03:43 2023&#39;, &#39;position&#39;: 345.5, &#39;type&#39;: &#39;HappiItem&#39;})</span>
 </pre></div>
 </div>
 <p>Or see how many entries are in the database:</p>
@@ -275,7 +275,7 @@ <h3>Searching a range<a class="headerlink" href="#searching-a-range" title="Perm
 <p>We can search a range of values with any arbitrary key using
 <a class="reference internal" href="api.html#happi.Client.search_range" title="happi.Client.search_range"><code class="xref py py-meth docutils literal notranslate"><span class="pre">Client.search_range()</span></code></a>. For example:</p>
 <div class="highlight-ipython notranslate"><div class="highlight"><pre><span></span><span class="gp">In [28]: </span><span class="n">client</span><span class="o">.</span><span class="n">search_range</span><span class="p">(</span><span class="s2">&quot;position&quot;</span><span class="p">,</span> <span class="n">start</span><span class="o">=</span><span class="mf">314.4</span><span class="p">,</span> <span class="n">end</span><span class="o">=</span><span class="mf">348.6</span><span class="p">)</span>
-<span class="gh">Out[28]: </span><span class="go">[SearchResult(client=&lt;happi.client.Client object at 0x7f8be1252100&gt;, metadata={&#39;name&#39;: &#39;my_device&#39;, &#39;device_class&#39;: &#39;types.SimpleNamespace&#39;, &#39;args&#39;: [], &#39;kwargs&#39;: {}, &#39;active&#39;: True, &#39;documentation&#39;: None, &#39;_id&#39;: &#39;my_device&#39;, &#39;creation&#39;: &#39;Fri Jun 30 20:49:52 2023&#39;, &#39;last_edit&#39;: &#39;Fri Jun 30 20:49:52 2023&#39;, &#39;position&#39;: 345.5, &#39;type&#39;: &#39;HappiItem&#39;})]</span>
+<span class="gh">Out[28]: </span><span class="go">[SearchResult(client=&lt;happi.client.Client object at 0x7f49ab3d9610&gt;, metadata={&#39;name&#39;: &#39;my_device&#39;, &#39;device_class&#39;: &#39;types.SimpleNamespace&#39;, &#39;args&#39;: [], &#39;kwargs&#39;: {}, &#39;active&#39;: True, &#39;documentation&#39;: None, &#39;_id&#39;: &#39;my_device&#39;, &#39;creation&#39;: &#39;Thu Jul 27 16:03:43 2023&#39;, &#39;last_edit&#39;: &#39;Thu Jul 27 16:03:43 2023&#39;, &#39;position&#39;: 345.5, &#39;type&#39;: &#39;HappiItem&#39;})]</span>
 </pre></div>
 </div>
 <p>This would return all items between positions 314.4 and 348.6.</p>
@@ -286,7 +286,7 @@ <h3>Searching a range<a class="headerlink" href="#searching-a-range" title="Perm
 <h3>Searching with regular expressions<a class="headerlink" href="#searching-with-regular-expressions" title="Permalink to this heading"></a></h3>
 <p>Any key can use a regular expression for searching by using <a class="reference internal" href="api.html#happi.Client.search_regex" title="happi.Client.search_regex"><code class="xref py py-meth docutils literal notranslate"><span class="pre">Client.search_regex()</span></code></a></p>
 <div class="highlight-ipython notranslate"><div class="highlight"><pre><span></span><span class="gp">In [29]: </span><span class="n">client</span><span class="o">.</span><span class="n">search_regex</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s1">&#39;my_device[2345]&#39;</span><span class="p">)</span>
-<span class="gh">Out[29]: </span><span class="go">[SearchResult(client=&lt;happi.client.Client object at 0x7f8be1252100&gt;, metadata={&#39;name&#39;: &#39;my_device2&#39;, &#39;device_class&#39;: &#39;types.SimpleNamespace&#39;, &#39;args&#39;: [], &#39;kwargs&#39;: {}, &#39;active&#39;: True, &#39;documentation&#39;: None, &#39;_id&#39;: &#39;my_device2&#39;, &#39;creation&#39;: &#39;Fri Jun 30 20:49:52 2023&#39;, &#39;last_edit&#39;: &#39;Fri Jun 30 20:49:52 2023&#39;, &#39;position&#39;: 355.5, &#39;type&#39;: &#39;HappiItem&#39;})]</span>
+<span class="gh">Out[29]: </span><span class="go">[SearchResult(client=&lt;happi.client.Client object at 0x7f49ab3d9610&gt;, metadata={&#39;name&#39;: &#39;my_device2&#39;, &#39;device_class&#39;: &#39;types.SimpleNamespace&#39;, &#39;args&#39;: [], &#39;kwargs&#39;: {}, &#39;active&#39;: True, &#39;documentation&#39;: None, &#39;_id&#39;: &#39;my_device2&#39;, &#39;creation&#39;: &#39;Thu Jul 27 16:03:43 2023&#39;, &#39;last_edit&#39;: &#39;Thu Jul 27 16:03:43 2023&#39;, &#39;position&#39;: 355.5, &#39;type&#39;: &#39;HappiItem&#39;})]</span>
 </pre></div>
 </div>
 </section>

master/containers.html

@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Containers &mdash; Happi 2.2.1.dev36+gee68d81 documentation</title>
+  <title>Containers &mdash; Happi 2.3.1.dev10+gc9d8248 documentation</title>
       <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
   <!--[if lt IE 9]>
@@ -35,7 +35,7 @@
             Happi
           </a>
               <div class="version">
-                2.2.1.dev36+gee68d81
+                2.3.1.dev10+gc9d8248
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
@@ -332,7 +332,7 @@ <h2>Loading your Object<a class="headerlink" href="#loading-your-object" title="
 <span class="gp">In [11]: </span><span class="n">obj</span> <span class="o">=</span> <span class="n">from_container</span><span class="p">(</span><span class="n">container</span><span class="p">,</span> <span class="n">attach_md</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
 
 <span class="gp">In [12]: </span><span class="n">obj</span>
-<span class="gh">Out[12]: </span><span class="go">SynSignal(name=&#39;my_item&#39;, value=0, timestamp=1688158192.9853163)</span>
+<span class="gh">Out[12]: </span><span class="go">SynSignal(name=&#39;my_item&#39;, value=0, timestamp=1690473824.0425837)</span>
 </pre></div>
 </div>
 </section>

master/generated/happi.backends.json_db.JSONBackend.html

@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>happi.backends.json_db.JSONBackend &mdash; Happi 2.2.1.dev36+gee68d81 documentation</title>
+  <title>happi.backends.json_db.JSONBackend &mdash; Happi 2.3.1.dev10+gc9d8248 documentation</title>
       <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
   <!--[if lt IE 9]>
@@ -35,7 +35,7 @@
             Happi
           </a>
               <div class="version">
-                2.2.1.dev36+gee68d81
+                2.3.1.dev10+gc9d8248
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">