Auto-update from Github Actions Workflow

Deployed from commit 4ca0168 (refs/heads/master)

Deployed from commit d65979b (refs/heads/master)

master/_sources/upcoming_release_notes/353-bld_subpackage.rst.txt

@@ -0,0 +1,24 @@
+353 bld_subpackage
+##################
+
+API Breaks
+----------
+- N/A
+
+Features
+--------
+- N/A
+
+Bugfixes
+--------
+- N/A
+
+Maintenance
+-----------
+- Splits happi pip package into subpackages (`gui`, `mongo`) for more precise dependency specification.
+  The default dependency set has can be installed via `pip install happi[all]`, and includes
+  the `gui` and `mongo` optional dependencies.
+
+Contributors
+------------
+- tangkong

master/_static/documentation_options.js

@@ -1,5 +1,5 @@
 const DOCUMENTATION_OPTIONS = {
-    VERSION: '2.6.1.dev3+g353edeb',
+    VERSION: '2.6.2.dev8+gd65979b',
     LANGUAGE: 'en',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',

master/api.html

@@ -6,14 +6,14 @@
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Happi API &mdash; Happi 2.6.1.dev3+g353edeb documentation</title>
+  <title>Happi API &mdash; Happi 2.6.2.dev8+gd65979b documentation</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=03e43079" />
       <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />
 
 
       <script src="_static/jquery.js?v=5d32c60e"></script>
       <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-      <script src="_static/documentation_options.js?v=aecadc41"></script>
+      <script src="_static/documentation_options.js?v=5dfc8966"></script>
       <script src="_static/doctools.js?v=9a2dae69"></script>
       <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/js/theme.js"></script>

master/cli.html

@@ -6,14 +6,14 @@
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Command Line Interface &mdash; Happi 2.6.1.dev3+g353edeb documentation</title>
+  <title>Command Line Interface &mdash; Happi 2.6.2.dev8+gd65979b documentation</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=03e43079" />
       <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />
 
 
       <script src="_static/jquery.js?v=5d32c60e"></script>
       <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-      <script src="_static/documentation_options.js?v=aecadc41"></script>
+      <script src="_static/documentation_options.js?v=5dfc8966"></script>
       <script src="_static/doctools.js?v=9a2dae69"></script>
       <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/js/theme.js"></script>

master/client.html

@@ -6,14 +6,14 @@
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Using the Client &mdash; Happi 2.6.1.dev3+g353edeb documentation</title>
+  <title>Using the Client &mdash; Happi 2.6.2.dev8+gd65979b documentation</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=03e43079" />
       <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />
 
 
       <script src="_static/jquery.js?v=5d32c60e"></script>
       <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-      <script src="_static/documentation_options.js?v=aecadc41"></script>
+      <script src="_static/documentation_options.js?v=5dfc8966"></script>
       <script src="_static/doctools.js?v=9a2dae69"></script>
       <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/js/theme.js"></script>
@@ -188,16 +188,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 0x7f4e12477550&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 Jan  9 21:00:22 2025&#39;, &#39;last_edit&#39;: &#39;Thu Jan  9 21:00:22 2025&#39;, &#39;position&#39;: 345.5, &#39;type&#39;: &#39;HappiItem&#39;}),</span>
-<span class="go"> SearchResult(client=&lt;happi.client.Client object at 0x7f4e12477550&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 Jan  9 21:00:22 2025&#39;, &#39;last_edit&#39;: &#39;Thu Jan  9 21:00:22 2025&#39;, &#39;position&#39;: 355.5, &#39;type&#39;: &#39;HappiItem&#39;})]</span>
+<span class="go">[SearchResult(client=&lt;happi.client.Client object at 0x7f6426919ac0&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;Tue Feb 11 20:33:42 2025&#39;, &#39;last_edit&#39;: &#39;Tue Feb 11 20:33:42 2025&#39;, &#39;position&#39;: 345.5, &#39;type&#39;: &#39;HappiItem&#39;}),</span>
+<span class="go"> SearchResult(client=&lt;happi.client.Client object at 0x7f6426919ac0&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;Tue Feb 11 20:33:42 2025&#39;, &#39;last_edit&#39;: &#39;Tue Feb 11 20:33:42 2025&#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 0x7f4e12477550&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 Jan  9 21:00:22 2025&#39;, &#39;last_edit&#39;: &#39;Thu Jan  9 21:00:22 2025&#39;, &#39;position&#39;: 345.5, &#39;type&#39;: &#39;HappiItem&#39;})),</span>
+<span class="go">  SearchResult(client=&lt;happi.client.Client object at 0x7f6426919ac0&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;Tue Feb 11 20:33:42 2025&#39;, &#39;last_edit&#39;: &#39;Tue Feb 11 20:33:42 2025&#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 0x7f4e12477550&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 Jan  9 21:00:22 2025&#39;, &#39;last_edit&#39;: &#39;Thu Jan  9 21:00:22 2025&#39;, &#39;position&#39;: 355.5, &#39;type&#39;: &#39;HappiItem&#39;}))]</span>
+<span class="go">  SearchResult(client=&lt;happi.client.Client object at 0x7f6426919ac0&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;Tue Feb 11 20:33:42 2025&#39;, &#39;last_edit&#39;: &#39;Tue Feb 11 20:33:42 2025&#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
@@ -208,7 +208,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 0x7f4e12477550&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 Jan  9 21:00:22 2025&#39;, &#39;last_edit&#39;: &#39;Thu Jan  9 21:00:22 2025&#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 0x7f6426919ac0&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;Tue Feb 11 20:33:42 2025&#39;, &#39;last_edit&#39;: &#39;Tue Feb 11 20:33:42 2025&#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>
@@ -272,7 +272,7 @@ <h3>Searching a range<a class="headerlink" href="#searching-a-range" title="Link
 <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 0x7f4e12477550&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 Jan  9 21:00:22 2025&#39;, &#39;last_edit&#39;: &#39;Thu Jan  9 21:00:22 2025&#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 0x7f6426919ac0&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;Tue Feb 11 20:33:42 2025&#39;, &#39;last_edit&#39;: &#39;Tue Feb 11 20:33:42 2025&#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>
@@ -283,7 +283,7 @@ <h3>Searching a range<a class="headerlink" href="#searching-a-range" title="Link
 <h3>Searching with regular expressions<a class="headerlink" href="#searching-with-regular-expressions" title="Link 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 0x7f4e12477550&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 Jan  9 21:00:22 2025&#39;, &#39;last_edit&#39;: &#39;Thu Jan  9 21:00:22 2025&#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 0x7f6426919ac0&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;Tue Feb 11 20:33:42 2025&#39;, &#39;last_edit&#39;: &#39;Tue Feb 11 20:33:42 2025&#39;, &#39;position&#39;: 355.5, &#39;type&#39;: &#39;HappiItem&#39;})]</span>
 </pre></div>
 </div>
 </section>

master/containers.html

@@ -6,14 +6,14 @@
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Containers &mdash; Happi 2.6.1.dev3+g353edeb documentation</title>
+  <title>Containers &mdash; Happi 2.6.2.dev8+gd65979b documentation</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=03e43079" />
       <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />
 
 
       <script src="_static/jquery.js?v=5d32c60e"></script>
       <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-      <script src="_static/documentation_options.js?v=aecadc41"></script>
+      <script src="_static/documentation_options.js?v=5dfc8966"></script>
       <script src="_static/doctools.js?v=9a2dae69"></script>
       <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/js/theme.js"></script>
@@ -329,7 +329,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=1736456422.7245681)</span>
+<span class="gh">Out[12]: </span><span class="go">SynSignal(name=&#39;my_item&#39;, value=0, timestamp=1739306022.8831935)</span>
 </pre></div>
 </div>
 </section>

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

@@ -6,14 +6,14 @@
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>happi.backends.json_db.JSONBackend &mdash; Happi 2.6.1.dev3+g353edeb documentation</title>
+  <title>happi.backends.json_db.JSONBackend &mdash; Happi 2.6.2.dev8+gd65979b documentation</title>
       <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=03e43079" />
       <link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=e59714d7" />
 
 
       <script src="../_static/jquery.js?v=5d32c60e"></script>
       <script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-      <script src="../_static/documentation_options.js?v=aecadc41"></script>
+      <script src="../_static/documentation_options.js?v=5dfc8966"></script>
       <script src="../_static/doctools.js?v=9a2dae69"></script>
       <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../_static/js/theme.js"></script>

master/generated/happi.backends.mongo_db.MongoBackend.html

@@ -6,14 +6,14 @@
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>happi.backends.mongo_db.MongoBackend &mdash; Happi 2.6.1.dev3+g353edeb documentation</title>
+  <title>happi.backends.mongo_db.MongoBackend &mdash; Happi 2.6.2.dev8+gd65979b documentation</title>
       <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=03e43079" />
       <link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=e59714d7" />
 
 
       <script src="../_static/jquery.js?v=5d32c60e"></script>
       <script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-      <script src="../_static/documentation_options.js?v=aecadc41"></script>
+      <script src="../_static/documentation_options.js?v=5dfc8966"></script>
       <script src="../_static/doctools.js?v=9a2dae69"></script>
       <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../_static/js/theme.js"></script>

master/generated/happi.backends.qs_db.QSBackend.html

@@ -6,14 +6,14 @@
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>happi.backends.qs_db.QSBackend &mdash; Happi 2.6.1.dev3+g353edeb documentation</title>
+  <title>happi.backends.qs_db.QSBackend &mdash; Happi 2.6.2.dev8+gd65979b documentation</title>
       <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=03e43079" />
       <link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=e59714d7" />
 
 
       <script src="../_static/jquery.js?v=5d32c60e"></script>
       <script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-      <script src="../_static/documentation_options.js?v=aecadc41"></script>
+      <script src="../_static/documentation_options.js?v=5dfc8966"></script>
       <script src="../_static/doctools.js?v=9a2dae69"></script>
       <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../_static/js/theme.js"></script>

master/genindex.html

@@ -5,14 +5,14 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Index &mdash; Happi 2.6.1.dev3+g353edeb documentation</title>
+  <title>Index &mdash; Happi 2.6.2.dev8+gd65979b documentation</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=03e43079" />
       <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />
 
 
       <script src="_static/jquery.js?v=5d32c60e"></script>
       <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-      <script src="_static/documentation_options.js?v=aecadc41"></script>
+      <script src="_static/documentation_options.js?v=5dfc8966"></script>
       <script src="_static/doctools.js?v=9a2dae69"></script>
       <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/js/theme.js"></script>