Skip to content

Commit

Permalink
Deploying to gh-pages from @ eb37d35 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
jkanche committed May 5, 2024
1 parent 2028757 commit f4ef853
Show file tree
Hide file tree
Showing 34 changed files with 586 additions and 412 deletions.
2 changes: 1 addition & 1 deletion .buildinfo
Original file line number Diff line number Diff line change
@@ -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: 50fb4f92fca3864a00eeb3302c888ed9
config: fa8b2be2ed6b6081f476f6c1395efeae
tags: 645f666f9bcd5a90fca523b33c5a78b7
28 changes: 15 additions & 13 deletions _modules/index.html
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
<!doctype html>
<html class="no-js" lang="en">
<html class="no-js" lang="en" data-content_root="../">
<head><meta charset="utf-8"/>
<meta name="viewport" content="width=device-width,initial-scale=1"/>
<meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" />

<!-- Generated with Sphinx 7.0.1 and Furo 2023.05.20 -->
<title>Overview: module code - pyBiocFileCache 0.2.2 documentation</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?digest=e6660623a769aa55fea372102b9bf3151b292993" />
<link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" />
<!-- Generated with Sphinx 7.3.7 and Furo 2024.04.27 -->
<title>Overview: module code - pyBiocFileCache 0.3.0 documentation</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?v=437aa6ec" />
<link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?v=36a5483c" />



Expand Down Expand Up @@ -111,6 +111,8 @@
<div class="visually-hidden">Hide table of contents sidebar</div>
</label>

<a class="skip-to-content muted-link" href="#furo-main-content">Skip to content</a>



<div class="page">
Expand All @@ -122,7 +124,7 @@
</label>
</div>
<div class="header-center">
<a href="../index.html"><div class="brand">pyBiocFileCache 0.2.2 documentation</div></a>
<a href="../index.html"><div class="brand">pyBiocFileCache 0.3.0 documentation</div></a>
</div>
<div class="header-right">
<div class="theme-toggle-container theme-toggle-header">
Expand All @@ -145,7 +147,7 @@
<div class="sidebar-sticky"><a class="sidebar-brand" href="../index.html">


<span class="sidebar-brand-text">pyBiocFileCache 0.2.2 documentation</span>
<span class="sidebar-brand-text">pyBiocFileCache 0.3.0 documentation</span>

</a><form class="sidebar-search-container" method="get" action="../search.html" role="search">
<input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
Expand Down Expand Up @@ -197,7 +199,7 @@
<i class="icon"><svg><use href="#svg-toc"></use></svg></i>
</label>
</div>
<article role="main">
<article role="main" id="furo-main-content">
<h1>All modules for which code is available</h1>
<ul><li><a href="pybiocfilecache/BiocFileCache.html">pybiocfilecache.BiocFileCache</a></li>
<li><a href="pybiocfilecache/db/Base.html">pybiocfilecache.db.Base</a></li>
Expand Down Expand Up @@ -235,9 +237,9 @@ <h1>All modules for which code is available</h1>

</aside>
</div>
</div><script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/sphinx_highlight.js"></script>
<script src="../_static/scripts/furo.js"></script>
</div><script src="../_static/documentation_options.js?v=e259d695"></script>
<script src="../_static/doctools.js?v=9a2dae69"></script>
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../_static/scripts/furo.js?v=4e2eecee"></script>
</body>
</html>
83 changes: 54 additions & 29 deletions _modules/pybiocfilecache/BiocFileCache.html

Large diffs are not rendered by default.

35 changes: 20 additions & 15 deletions _modules/pybiocfilecache/db/Base.html
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
<!doctype html>
<html class="no-js" lang="en">
<html class="no-js" lang="en" data-content_root="../../../">
<head><meta charset="utf-8"/>
<meta name="viewport" content="width=device-width,initial-scale=1"/>
<meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="../../../genindex.html" /><link rel="search" title="Search" href="../../../search.html" />

<!-- Generated with Sphinx 7.0.1 and Furo 2023.05.20 -->
<title>pybiocfilecache.db.Base - pyBiocFileCache 0.2.2 documentation</title>
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo.css?digest=e6660623a769aa55fea372102b9bf3151b292993" />
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" />
<!-- Generated with Sphinx 7.3.7 and Furo 2024.04.27 -->
<title>pybiocfilecache.db.Base - pyBiocFileCache 0.3.0 documentation</title>
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo.css?v=437aa6ec" />
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo-extensions.css?v=36a5483c" />



Expand Down Expand Up @@ -111,6 +111,8 @@
<div class="visually-hidden">Hide table of contents sidebar</div>
</label>

<a class="skip-to-content muted-link" href="#furo-main-content">Skip to content</a>



<div class="page">
Expand All @@ -122,7 +124,7 @@
</label>
</div>
<div class="header-center">
<a href="../../../index.html"><div class="brand">pyBiocFileCache 0.2.2 documentation</div></a>
<a href="../../../index.html"><div class="brand">pyBiocFileCache 0.3.0 documentation</div></a>
</div>
<div class="header-right">
<div class="theme-toggle-container theme-toggle-header">
Expand All @@ -145,7 +147,7 @@
<div class="sidebar-sticky"><a class="sidebar-brand" href="../../../index.html">


<span class="sidebar-brand-text">pyBiocFileCache 0.2.2 documentation</span>
<span class="sidebar-brand-text">pyBiocFileCache 0.3.0 documentation</span>

</a><form class="sidebar-search-container" method="get" action="../../../search.html" role="search">
<input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
Expand Down Expand Up @@ -197,7 +199,7 @@
<i class="icon"><svg><use href="#svg-toc"></use></svg></i>
</label>
</div>
<article role="main">
<article role="main" id="furo-main-content">
<h1>Source code for pybiocfilecache.db.Base</h1><div class="highlight"><pre>
<span></span><span class="kn">from</span> <span class="nn">sqlalchemy</span> <span class="kn">import</span> <span class="n">create_engine</span>
<span class="kn">from</span> <span class="nn">sqlalchemy.engine</span> <span class="kn">import</span> <span class="n">Engine</span>
Expand All @@ -213,8 +215,10 @@ <h1>Source code for pybiocfilecache.db.Base</h1><div class="highlight"><pre>
<span class="n">Base</span> <span class="o">=</span> <span class="n">declarative_base</span><span class="p">()</span>


<div class="viewcode-block" id="create_schema"><a class="viewcode-back" href="../../../api/pybiocfilecache.db.html#pybiocfilecache.db.Base.create_schema">[docs]</a><span class="k">def</span> <span class="nf">create_schema</span><span class="p">(</span><span class="n">cache_dir</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Tuple</span><span class="p">[</span><span class="n">Engine</span><span class="p">,</span> <span class="n">sessionmaker</span><span class="p">]:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Create the schema in the sqlite database</span>
<div class="viewcode-block" id="create_schema">
<a class="viewcode-back" href="../../../api/pybiocfilecache.db.html#pybiocfilecache.db.Base.create_schema">[docs]</a>
<span class="k">def</span> <span class="nf">create_schema</span><span class="p">(</span><span class="n">cache_dir</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Tuple</span><span class="p">[</span><span class="n">Engine</span><span class="p">,</span> <span class="n">sessionmaker</span><span class="p">]:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Create the schema in the sqlite database.</span>

<span class="sd"> Args:</span>
<span class="sd"> cache_dir (str): Location where the cache directory</span>
Expand All @@ -233,6 +237,7 @@ <h1>Source code for pybiocfilecache.db.Base</h1><div class="highlight"><pre>
<span class="k">return</span> <span class="p">(</span><span class="n">engine</span><span class="p">,</span> <span class="n">sessionLocal</span><span class="p">)</span>
<span class="k">except</span> <span class="ne">Exception</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">e</span></div>

</pre></div>
</article>
</div>
Expand Down Expand Up @@ -265,9 +270,9 @@ <h1>Source code for pybiocfilecache.db.Base</h1><div class="highlight"><pre>

</aside>
</div>
</div><script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js"></script>
<script src="../../../_static/doctools.js"></script>
<script src="../../../_static/sphinx_highlight.js"></script>
<script src="../../../_static/scripts/furo.js"></script>
</div><script src="../../../_static/documentation_options.js?v=e259d695"></script>
<script src="../../../_static/doctools.js?v=9a2dae69"></script>
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../../../_static/scripts/furo.js?v=4e2eecee"></script>
</body>
</html>
37 changes: 22 additions & 15 deletions _modules/pybiocfilecache/db/schema.html
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
<!doctype html>
<html class="no-js" lang="en">
<html class="no-js" lang="en" data-content_root="../../../">
<head><meta charset="utf-8"/>
<meta name="viewport" content="width=device-width,initial-scale=1"/>
<meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="../../../genindex.html" /><link rel="search" title="Search" href="../../../search.html" />

<!-- Generated with Sphinx 7.0.1 and Furo 2023.05.20 -->
<title>pybiocfilecache.db.schema - pyBiocFileCache 0.2.2 documentation</title>
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo.css?digest=e6660623a769aa55fea372102b9bf3151b292993" />
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" />
<!-- Generated with Sphinx 7.3.7 and Furo 2024.04.27 -->
<title>pybiocfilecache.db.schema - pyBiocFileCache 0.3.0 documentation</title>
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo.css?v=437aa6ec" />
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo-extensions.css?v=36a5483c" />



Expand Down Expand Up @@ -111,6 +111,8 @@
<div class="visually-hidden">Hide table of contents sidebar</div>
</label>

<a class="skip-to-content muted-link" href="#furo-main-content">Skip to content</a>



<div class="page">
Expand All @@ -122,7 +124,7 @@
</label>
</div>
<div class="header-center">
<a href="../../../index.html"><div class="brand">pyBiocFileCache 0.2.2 documentation</div></a>
<a href="../../../index.html"><div class="brand">pyBiocFileCache 0.3.0 documentation</div></a>
</div>
<div class="header-right">
<div class="theme-toggle-container theme-toggle-header">
Expand All @@ -145,7 +147,7 @@
<div class="sidebar-sticky"><a class="sidebar-brand" href="../../../index.html">


<span class="sidebar-brand-text">pyBiocFileCache 0.2.2 documentation</span>
<span class="sidebar-brand-text">pyBiocFileCache 0.3.0 documentation</span>

</a><form class="sidebar-search-container" method="get" action="../../../search.html" role="search">
<input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
Expand Down Expand Up @@ -197,7 +199,7 @@
<i class="icon"><svg><use href="#svg-toc"></use></svg></i>
</label>
</div>
<article role="main">
<article role="main" id="furo-main-content">
<h1>Source code for pybiocfilecache.db.schema</h1><div class="highlight"><pre>
<span></span><span class="kn">from</span> <span class="nn">sqlalchemy</span> <span class="kn">import</span> <span class="n">Column</span><span class="p">,</span> <span class="n">DateTime</span><span class="p">,</span> <span class="n">Integer</span><span class="p">,</span> <span class="n">String</span>
<span class="kn">from</span> <span class="nn">sqlalchemy.sql</span> <span class="kn">import</span> <span class="n">func</span>
Expand All @@ -209,7 +211,9 @@ <h1>Source code for pybiocfilecache.db.schema</h1><div class="highlight"><pre>
<span class="n">__license__</span> <span class="o">=</span> <span class="s2">&quot;MIT&quot;</span>


<div class="viewcode-block" id="Metadata"><a class="viewcode-back" href="../../../api/pybiocfilecache.db.html#pybiocfilecache.db.schema.Metadata">[docs]</a><span class="k">class</span> <span class="nc">Metadata</span><span class="p">(</span><span class="n">Base</span><span class="p">):</span>
<div class="viewcode-block" id="Metadata">
<a class="viewcode-back" href="../../../api/pybiocfilecache.db.html#pybiocfilecache.db.schema.Metadata">[docs]</a>
<span class="k">class</span> <span class="nc">Metadata</span><span class="p">(</span><span class="n">Base</span><span class="p">):</span>
<span class="n">__tablename__</span> <span class="o">=</span> <span class="s2">&quot;metadata&quot;</span>
<span class="n">key</span> <span class="o">=</span> <span class="n">Column</span><span class="p">(</span><span class="n">String</span><span class="p">(),</span> <span class="n">primary_key</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">index</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
<span class="n">value</span> <span class="o">=</span> <span class="n">Column</span><span class="p">(</span><span class="n">String</span><span class="p">())</span>
Expand All @@ -218,7 +222,10 @@ <h1>Source code for pybiocfilecache.db.schema</h1><div class="highlight"><pre>
<span class="k">return</span> <span class="s2">&quot;&lt;Metadata(key=&#39;</span><span class="si">%s</span><span class="s2">&#39;, valye=&#39;</span><span class="si">%s</span><span class="s2">&#39;)&gt;&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">key</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">value</span><span class="p">)</span></div>


<div class="viewcode-block" id="Resource"><a class="viewcode-back" href="../../../api/pybiocfilecache.db.html#pybiocfilecache.db.schema.Resource">[docs]</a><span class="k">class</span> <span class="nc">Resource</span><span class="p">(</span><span class="n">Base</span><span class="p">):</span>

<div class="viewcode-block" id="Resource">
<a class="viewcode-back" href="../../../api/pybiocfilecache.db.html#pybiocfilecache.db.schema.Resource">[docs]</a>
<span class="k">class</span> <span class="nc">Resource</span><span class="p">(</span><span class="n">Base</span><span class="p">):</span>
<span class="n">__tablename__</span> <span class="o">=</span> <span class="s2">&quot;resource&quot;</span>
<span class="nb">id</span> <span class="o">=</span> <span class="n">Column</span><span class="p">(</span><span class="n">Integer</span><span class="p">,</span> <span class="n">primary_key</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">index</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">autoincrement</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
<span class="n">rid</span> <span class="o">=</span> <span class="n">Column</span><span class="p">(</span><span class="n">String</span><span class="p">())</span>
Expand Down Expand Up @@ -267,9 +274,9 @@ <h1>Source code for pybiocfilecache.db.schema</h1><div class="highlight"><pre>

</aside>
</div>
</div><script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js"></script>
<script src="../../../_static/doctools.js"></script>
<script src="../../../_static/sphinx_highlight.js"></script>
<script src="../../../_static/scripts/furo.js"></script>
</div><script src="../../../_static/documentation_options.js?v=e259d695"></script>
<script src="../../../_static/doctools.js?v=9a2dae69"></script>
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../../../_static/scripts/furo.js?v=4e2eecee"></script>
</body>
</html>
Loading

0 comments on commit f4ef853

Please sign in to comment.