Update documentation

CveXplore/api/ApiDatabaseCollection.__init__.html

@@ -32,7 +32,7 @@
  <style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
 
 
- <link rel="stylesheet" type="text/css" href="../../_static/sphinx_immaterial_theme.e0b5691b38cca82da.min.css?v=b1736040" />
+ <link rel="stylesheet" type="text/css" href="../../_static/sphinx_immaterial_theme.3625f807144f53acf.min.css?v=fbfc4466" />
  <link rel="stylesheet" type="text/css" href="../../_static/custom.css?v=df571175" />
  <script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce((e,_)=>(e<<5)-e+_.charCodeAt(0),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
 
@@ -576,7 +576,7 @@
 
 <dl class="py method objdesc">
 <dt class="sig sig-object highlight sig-wrap py">
-<span class="sig-prename descclassname"><span class="pre">CveXplore.api.connection.api_db.</span></span><span class="sig-name descname"><span class="pre">ApiDatabaseCollection</span></span><span class="sig-paren">(</span><span class="sig-param-decl"><em class="sig-param"><span class="n"><span class="pre">baseurl</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="desctype"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a></span></span></em>, </span><span class="sig-param-decl"><em class="sig-param"><span class="n"><span class="pre">collname</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="desctype"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a></span></span></em>, </span><span class="sig-param-decl"><em class="sig-param"><span class="n"><span class="pre">api_path</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="desctype"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><code class="code python default_value docutils literal highlight highlight-python"><span class="kc">None</span></code></em>, </span><span class="sig-param-decl"><em class="sig-param"><span class="n"><span class="pre">proxies</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="desctype"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.12)"><span class="pre">dict</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><code class="code python default_value docutils literal highlight highlight-python"><span class="kc">None</span></code></em>, </span><span class="sig-param-decl"><em class="sig-param"><span class="n"><span class="pre">user_agent</span></span><span class="o"><span class="pre">=</span></span><code class="code python default_value docutils literal highlight highlight-python"><span class="s1">&#39;CveXplore&#39;</span></code></em></span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/CveXplore/api/connection/api_db.html#ApiDatabaseCollection.__init__"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
+<span class="sig-prename descclassname"><span class="pre">CveXplore.api.connection.api_db.</span></span><span class="sig-name descname"><span class="pre">ApiDatabaseCollection</span></span><span class="sig-paren">(</span><span class="sig-param-decl"><em class="sig-param"><a class="n reference internal" href="#" title="CveXplore.api.connection.api_db.ApiDatabaseCollection.__init__.baseurl (Python parameter)"><span class="n"><span class="pre">baseurl</span></span></a><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="desctype"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a></span></span></em>, </span><span class="sig-param-decl"><em class="sig-param"><a class="n reference internal" href="#" title="CveXplore.api.connection.api_db.ApiDatabaseCollection.__init__.collname (Python parameter)"><span class="n"><span class="pre">collname</span></span></a><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="desctype"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a></span></span></em>, </span><span class="sig-param-decl"><em class="sig-param"><a class="n reference internal" href="#" title="CveXplore.api.connection.api_db.ApiDatabaseCollection.__init__.api_path (Python parameter)"><span class="n"><span class="pre">api_path</span></span></a><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="desctype"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><code class="code python default_value docutils literal highlight highlight-python"><span class="kc">None</span></code></em>, </span><span class="sig-param-decl"><em class="sig-param"><a class="n reference internal" href="#" title="CveXplore.api.connection.api_db.ApiDatabaseCollection.__init__.proxies (Python parameter)"><span class="n"><span class="pre">proxies</span></span></a><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="desctype"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.12)"><span class="pre">dict</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><code class="code python default_value docutils literal highlight highlight-python"><span class="kc">None</span></code></em>, </span><span class="sig-param-decl"><em class="sig-param"><a class="n reference internal" href="#" title="CveXplore.api.connection.api_db.ApiDatabaseCollection.__init__.user_agent (Python parameter)"><span class="n"><span class="pre">user_agent</span></span></a><span class="o"><span class="pre">=</span></span><code class="code python default_value docutils literal highlight highlight-python"><span class="s1">&#39;CveXplore&#39;</span></code></em></span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/CveXplore/api/connection/api_db.html#ApiDatabaseCollection.__init__"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
 <dd><p>Create a new ApiDatabaseCollection.</p>
 </dd></dl>
 
@@ -587,7 +587,7 @@
  <small>
 
  Last update:
- Jul 05, 2024
+ Aug 09, 2024
 
  </small>
 </div>
@@ -628,7 +628,7 @@
 
  Created using
  <a href="https://www.sphinx-doc.org/" target="_blank" rel="noopener">Sphinx</a>
- 7.3.7.
+ 7.4.7.
  and
  <a href="https://github.com/jbms/sphinx-immaterial/" target="_blank" rel="noopener">Sphinx-Immaterial</a>
 

CveXplore/api/ApiDatabaseCollection.__repr__.html

@@ -32,7 +32,7 @@
  <style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
 
 
- <link rel="stylesheet" type="text/css" href="../../_static/sphinx_immaterial_theme.e0b5691b38cca82da.min.css?v=b1736040" />
+ <link rel="stylesheet" type="text/css" href="../../_static/sphinx_immaterial_theme.3625f807144f53acf.min.css?v=fbfc4466" />
  <link rel="stylesheet" type="text/css" href="../../_static/custom.css?v=df571175" />
  <script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce((e,_)=>(e<<5)-e+_.charCodeAt(0),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
 
@@ -587,7 +587,7 @@
  <small>
 
  Last update:
- Jul 05, 2024
+ Aug 09, 2024
 
  </small>
 </div>
@@ -628,7 +628,7 @@
 
  Created using
  <a href="https://www.sphinx-doc.org/" target="_blank" rel="noopener">Sphinx</a>
- 7.3.7.
+ 7.4.7.
  and
  <a href="https://github.com/jbms/sphinx-immaterial/" target="_blank" rel="noopener">Sphinx-Immaterial</a>
 

CveXplore/api/ApiDatabaseCollection.find.html

@@ -32,7 +32,7 @@
  <style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
 
 
- <link rel="stylesheet" type="text/css" href="../../_static/sphinx_immaterial_theme.e0b5691b38cca82da.min.css?v=b1736040" />
+ <link rel="stylesheet" type="text/css" href="../../_static/sphinx_immaterial_theme.3625f807144f53acf.min.css?v=fbfc4466" />
  <link rel="stylesheet" type="text/css" href="../../_static/custom.css?v=df571175" />
  <script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce((e,_)=>(e<<5)-e+_.charCodeAt(0),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
 
@@ -575,8 +575,8 @@
 
 
 <dl class="py method objdesc">
-<dt class="sig sig-object highlight py">
-<span class="sig-prename descclassname"><span class="pre">CveXplore.api.connection.api_db.</span><span class="pre">ApiDatabaseCollection.</span></span><span class="sig-name descname"><span class="pre">find</span></span><span class="sig-paren">(</span><span class="sig-param-decl"><em class="sig-param"><span class="n"><span class="pre">the_filter</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="desctype"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.12)"><span class="pre">dict</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><code class="code python default_value docutils literal highlight highlight-python"><span class="kc">None</span></code></em></span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/CveXplore/api/connection/api_db.html#ApiDatabaseCollection.find"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
+<dt class="sig sig-object highlight sig-wrap py">
+<span class="sig-prename descclassname"><span class="pre">CveXplore.api.connection.api_db.</span><span class="pre">ApiDatabaseCollection.</span></span><span class="sig-name descname"><span class="pre">find</span></span><span class="sig-paren">(</span><span class="sig-param-decl"><em class="sig-param"><a class="n reference internal" href="#" title="CveXplore.api.connection.api_db.ApiDatabaseCollection.find.the_filter (Python parameter)"><span class="n"><span class="pre">the_filter</span></span></a><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="desctype"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.12)"><span class="pre">dict</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><code class="code python default_value docutils literal highlight highlight-python"><span class="kc">None</span></code></em></span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/CveXplore/api/connection/api_db.html#ApiDatabaseCollection.find"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
 <dd><p>Query the api endpoint as you would do so with a pymongo Collection.</p>
 </dd></dl>
 
@@ -587,7 +587,7 @@
  <small>
 
  Last update:
- Jul 05, 2024
+ Aug 09, 2024
 
  </small>
 </div>
@@ -628,7 +628,7 @@
 
  Created using
  <a href="https://www.sphinx-doc.org/" target="_blank" rel="noopener">Sphinx</a>
- 7.3.7.
+ 7.4.7.
  and
  <a href="https://github.com/jbms/sphinx-immaterial/" target="_blank" rel="noopener">Sphinx-Immaterial</a>
 

CveXplore/api/ApiDatabaseCollection.find_one.html

@@ -32,7 +32,7 @@
  <style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
 
 
- <link rel="stylesheet" type="text/css" href="../../_static/sphinx_immaterial_theme.e0b5691b38cca82da.min.css?v=b1736040" />
+ <link rel="stylesheet" type="text/css" href="../../_static/sphinx_immaterial_theme.3625f807144f53acf.min.css?v=fbfc4466" />
  <link rel="stylesheet" type="text/css" href="../../_static/custom.css?v=df571175" />
  <script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce((e,_)=>(e<<5)-e+_.charCodeAt(0),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
 
@@ -575,8 +575,8 @@
 
 
 <dl class="py method objdesc">
-<dt class="sig sig-object highlight py">
-<span class="sig-prename descclassname"><span class="pre">CveXplore.api.connection.api_db.</span><span class="pre">ApiDatabaseCollection.</span></span><span class="sig-name descname"><span class="pre">find_one</span></span><span class="sig-paren">(</span><span class="sig-param-decl"><em class="sig-param"><span class="n"><span class="pre">the_filter</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="desctype"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.12)"><span class="pre">dict</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><code class="code python default_value docutils literal highlight highlight-python"><span class="kc">None</span></code></em></span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/CveXplore/api/connection/api_db.html#ApiDatabaseCollection.find_one"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
+<dt class="sig sig-object highlight sig-wrap py">
+<span class="sig-prename descclassname"><span class="pre">CveXplore.api.connection.api_db.</span><span class="pre">ApiDatabaseCollection.</span></span><span class="sig-name descname"><span class="pre">find_one</span></span><span class="sig-paren">(</span><span class="sig-param-decl"><em class="sig-param"><a class="n reference internal" href="#" title="CveXplore.api.connection.api_db.ApiDatabaseCollection.find_one.the_filter (Python parameter)"><span class="n"><span class="pre">the_filter</span></span></a><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="desctype"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.12)"><span class="pre">dict</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><code class="code python default_value docutils literal highlight highlight-python"><span class="kc">None</span></code></em></span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/CveXplore/api/connection/api_db.html#ApiDatabaseCollection.find_one"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
 <dd><p>Query the api endpoint as you would do so with a pymongo Collection.</p>
 <dl class="field-list simple">
 <dt class="field-odd" id="returns">Returns<span class="colon">:</span><a class="headerlink" href="#returns" title="Permalink to this headline">¶</a></dt>
@@ -595,7 +595,7 @@
  <small>
 
  Last update:
- Jul 05, 2024
+ Aug 09, 2024
 
  </small>
 </div>
@@ -636,7 +636,7 @@
 
  Created using
  <a href="https://www.sphinx-doc.org/" target="_blank" rel="noopener">Sphinx</a>
- 7.3.7.
+ 7.4.7.
  and
  <a href="https://github.com/jbms/sphinx-immaterial/" target="_blank" rel="noopener">Sphinx-Immaterial</a>