Skip to content

Commit

Permalink
deploy: ab2dba0
Browse files Browse the repository at this point in the history
  • Loading branch information
malmans2 committed Jan 8, 2025
1 parent fc2d158 commit 964b535
Show file tree
Hide file tree
Showing 23 changed files with 509 additions and 431 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 records the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 6fe7aad468c9f724c38004f226d25931
config: 6e99f04e7045d593b09bf69bab688718
tags: 645f666f9bcd5a90fca523b33c5a78b7
60 changes: 33 additions & 27 deletions README.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,16 +8,16 @@
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />

<title>datapi &#8212; datapi 0.1.1 documentation</title>
<title>datapi &#8212; datapi 0.1.2 documentation</title>



<script data-cfasync="false">
document.documentElement.dataset.mode = localStorage.getItem("mode") || "";
document.documentElement.dataset.theme = localStorage.getItem("theme") || "";
</script>
<!--
this give us a css class that will be invisible only if js is disabled
<!--
this give us a css class that will be invisible only if js is disabled
-->
<noscript>
<style>
Expand All @@ -27,19 +27,19 @@
</noscript>

<!-- Loaded before other Sphinx assets -->
<link href="_static/styles/theme.css?digest=26a4bc78f4c0ddb94549" rel="stylesheet" />
<link href="_static/styles/pydata-sphinx-theme.css?digest=26a4bc78f4c0ddb94549" rel="stylesheet" />
<link href="_static/styles/theme.css?digest=8878045cc6db502f8baf" rel="stylesheet" />
<link href="_static/styles/pydata-sphinx-theme.css?digest=8878045cc6db502f8baf" rel="stylesheet" />

<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=a746c00c" />
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=8f2a1f02" />
<link rel="stylesheet" type="text/css" href="_static/graphviz.css?v=4ae1632d" />

<!-- So that users can add custom icons -->
<script src="_static/scripts/fontawesome.js?digest=26a4bc78f4c0ddb94549"></script>
<script src="_static/scripts/fontawesome.js?digest=8878045cc6db502f8baf"></script>
<!-- Pre-loaded scripts that we'll load fully later -->
<link rel="preload" as="script" href="_static/scripts/bootstrap.js?digest=26a4bc78f4c0ddb94549" />
<link rel="preload" as="script" href="_static/scripts/pydata-sphinx-theme.js?digest=26a4bc78f4c0ddb94549" />
<link rel="preload" as="script" href="_static/scripts/bootstrap.js?digest=8878045cc6db502f8baf" />
<link rel="preload" as="script" href="_static/scripts/pydata-sphinx-theme.js?digest=8878045cc6db502f8baf" />

<script src="_static/documentation_options.js?v=a58bc63e"></script>
<script src="_static/documentation_options.js?v=92734c54"></script>
<script src="_static/doctools.js?v=9bcbadda"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script>DOCUMENTATION_OPTIONS.pagename = 'README';</script>
Expand All @@ -49,7 +49,7 @@
<link rel="prev" title="Welcome to datapi’s documentation!" href="index.html" />
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="docsearch:language" content="en"/>
<meta name="docsearch:version" content="0.1.1" />
<meta name="docsearch:version" content="0.1.2" />
</head>


Expand Down Expand Up @@ -111,7 +111,7 @@



<p class="title logo__title">datapi 0.1.1 documentation</p>
<p class="title logo__title">datapi 0.1.2 documentation</p>

</a></div>

Expand Down Expand Up @@ -257,9 +257,14 @@


<div class="sidebar-primary-items__end sidebar-primary__section">
<div class="sidebar-primary-item">
<div id="ethical-ad-placement"
class="flat"
data-ea-publisher="readthedocs"
data-ea-type="readthedocs-sidebar"
data-ea-manual="true">
</div></div>
</div>

<div id="rtd-footer-container"></div>


</div>
Expand Down Expand Up @@ -335,14 +340,14 @@ <h2>Configuration<a class="headerlink" href="#configuration" title="Link to this
<section id="quick-start">
<h2>Quick Start<a class="headerlink" href="#quick-start" title="Link to this heading">#</a></h2>
<p>Configure the logging level to display INFO messages:</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">import</span> <span class="nn">logging</span>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">import</span><span class="w"> </span><span class="nn">logging</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">logging</span><span class="o">.</span><span class="n">basicConfig</span><span class="p">(</span><span class="n">level</span><span class="o">=</span><span class="s2">&quot;INFO&quot;</span><span class="p">)</span>

</pre></div>
</div>
<p>Instantiate the API client and verify the authentication:</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">import</span> <span class="nn">os</span>
<span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">datapi</span> <span class="kn">import</span> <span class="n">ApiClient</span>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">import</span><span class="w"> </span><span class="nn">os</span>
<span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span><span class="w"> </span><span class="nn">datapi</span><span class="w"> </span><span class="kn">import</span> <span class="n">ApiClient</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">client</span> <span class="o">=</span> <span class="n">ApiClient</span><span class="p">(</span>
<span class="gp">... </span> <span class="n">url</span><span class="o">=</span><span class="n">os</span><span class="o">.</span><span class="n">getenv</span><span class="p">(</span><span class="s2">&quot;DATAPI_URL&quot;</span><span class="p">),</span>
<span class="gp">... </span> <span class="n">key</span><span class="o">=</span><span class="n">os</span><span class="o">.</span><span class="n">getenv</span><span class="p">(</span><span class="s2">&quot;DATAPI_KEY&quot;</span><span class="p">),</span>
Expand Down Expand Up @@ -488,13 +493,13 @@ <h2>License<a class="headerlink" href="#license" title="Link to this heading">#<
</nav></div>

<div class="sidebar-secondary-item">

<div class="tocsection sourcelink">
<a href="_sources/README.md.txt">
<i class="fa-solid fa-file-lines"></i> Show Source
</a>
</div>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/README.md.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div></div>

</div></div>

Expand All @@ -509,8 +514,8 @@ <h2>License<a class="headerlink" href="#license" title="Link to this heading">#<
</div>

<!-- Scripts loaded after <body> so the DOM is not blocked -->
<script defer src="_static/scripts/bootstrap.js?digest=26a4bc78f4c0ddb94549"></script>
<script defer src="_static/scripts/pydata-sphinx-theme.js?digest=26a4bc78f4c0ddb94549"></script>
<script defer src="_static/scripts/bootstrap.js?digest=8878045cc6db502f8baf"></script>
<script defer src="_static/scripts/pydata-sphinx-theme.js?digest=8878045cc6db502f8baf"></script>

<footer class="bd-footer">
<div class="bd-footer__inner bd-page-width">
Expand Down Expand Up @@ -543,7 +548,8 @@ <h2>License<a class="headerlink" href="#license" title="Link to this heading">#<

<div class="footer-item">
<p class="theme-version">
Built with the <a href="https://pydata-sphinx-theme.readthedocs.io/en/stable/index.html">PyData Sphinx Theme</a> 0.16.0.
<!-- # L10n: Setting the PST URL as an argument as this does not need to be localized -->
Built with the <a href="https://pydata-sphinx-theme.readthedocs.io/en/stable/index.html">PyData Sphinx Theme</a> 0.16.1.
</p></div>

</div>
Expand Down
54 changes: 30 additions & 24 deletions _api/datapi/ApiClient.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,16 +8,16 @@
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />

<title>datapi.ApiClient &#8212; datapi 0.1.1 documentation</title>
<title>datapi.ApiClient &#8212; datapi 0.1.2 documentation</title>



<script data-cfasync="false">
document.documentElement.dataset.mode = localStorage.getItem("mode") || "";
document.documentElement.dataset.theme = localStorage.getItem("theme") || "";
</script>
<!--
this give us a css class that will be invisible only if js is disabled
<!--
this give us a css class that will be invisible only if js is disabled
-->
<noscript>
<style>
Expand All @@ -27,19 +27,19 @@
</noscript>

<!-- Loaded before other Sphinx assets -->
<link href="../../_static/styles/theme.css?digest=26a4bc78f4c0ddb94549" rel="stylesheet" />
<link href="../../_static/styles/pydata-sphinx-theme.css?digest=26a4bc78f4c0ddb94549" rel="stylesheet" />
<link href="../../_static/styles/theme.css?digest=8878045cc6db502f8baf" rel="stylesheet" />
<link href="../../_static/styles/pydata-sphinx-theme.css?digest=8878045cc6db502f8baf" rel="stylesheet" />

<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=a746c00c" />
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=8f2a1f02" />
<link rel="stylesheet" type="text/css" href="../../_static/graphviz.css?v=4ae1632d" />

<!-- So that users can add custom icons -->
<script src="../../_static/scripts/fontawesome.js?digest=26a4bc78f4c0ddb94549"></script>
<script src="../../_static/scripts/fontawesome.js?digest=8878045cc6db502f8baf"></script>
<!-- Pre-loaded scripts that we'll load fully later -->
<link rel="preload" as="script" href="../../_static/scripts/bootstrap.js?digest=26a4bc78f4c0ddb94549" />
<link rel="preload" as="script" href="../../_static/scripts/pydata-sphinx-theme.js?digest=26a4bc78f4c0ddb94549" />
<link rel="preload" as="script" href="../../_static/scripts/bootstrap.js?digest=8878045cc6db502f8baf" />
<link rel="preload" as="script" href="../../_static/scripts/pydata-sphinx-theme.js?digest=8878045cc6db502f8baf" />

<script src="../../_static/documentation_options.js?v=a58bc63e"></script>
<script src="../../_static/documentation_options.js?v=92734c54"></script>
<script src="../../_static/doctools.js?v=9bcbadda"></script>
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
<script>DOCUMENTATION_OPTIONS.pagename = '_api/datapi/ApiClient';</script>
Expand All @@ -49,7 +49,7 @@
<link rel="prev" title="datapi" href="index.html" />
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="docsearch:language" content="en"/>
<meta name="docsearch:version" content="0.1.1" />
<meta name="docsearch:version" content="0.1.2" />
</head>


Expand Down Expand Up @@ -111,7 +111,7 @@



<p class="title logo__title">datapi 0.1.1 documentation</p>
<p class="title logo__title">datapi 0.1.2 documentation</p>

</a></div>

Expand Down Expand Up @@ -266,9 +266,14 @@


<div class="sidebar-primary-items__end sidebar-primary__section">
<div class="sidebar-primary-item">
<div id="ethical-ad-placement"
class="flat"
data-ea-publisher="readthedocs"
data-ea-type="readthedocs-sidebar"
data-ea-manual="true">
</div></div>
</div>

<div id="rtd-footer-container"></div>


</div>
Expand Down Expand Up @@ -689,13 +694,13 @@ <h1>datapi.ApiClient<a class="headerlink" href="#datapi-apiclient" title="Link t
</nav></div>

<div class="sidebar-secondary-item">

<div class="tocsection sourcelink">
<a href="../../_sources/_api/datapi/ApiClient.rst.txt">
<i class="fa-solid fa-file-lines"></i> Show Source
</a>
</div>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../../_sources/_api/datapi/ApiClient.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div></div>

</div></div>

Expand All @@ -710,8 +715,8 @@ <h1>datapi.ApiClient<a class="headerlink" href="#datapi-apiclient" title="Link t
</div>

<!-- Scripts loaded after <body> so the DOM is not blocked -->
<script defer src="../../_static/scripts/bootstrap.js?digest=26a4bc78f4c0ddb94549"></script>
<script defer src="../../_static/scripts/pydata-sphinx-theme.js?digest=26a4bc78f4c0ddb94549"></script>
<script defer src="../../_static/scripts/bootstrap.js?digest=8878045cc6db502f8baf"></script>
<script defer src="../../_static/scripts/pydata-sphinx-theme.js?digest=8878045cc6db502f8baf"></script>

<footer class="bd-footer">
<div class="bd-footer__inner bd-page-width">
Expand Down Expand Up @@ -744,7 +749,8 @@ <h1>datapi.ApiClient<a class="headerlink" href="#datapi-apiclient" title="Link t

<div class="footer-item">
<p class="theme-version">
Built with the <a href="https://pydata-sphinx-theme.readthedocs.io/en/stable/index.html">PyData Sphinx Theme</a> 0.16.0.
<!-- # L10n: Setting the PST URL as an argument as this does not need to be localized -->
Built with the <a href="https://pydata-sphinx-theme.readthedocs.io/en/stable/index.html">PyData Sphinx Theme</a> 0.16.1.
</p></div>

</div>
Expand Down
54 changes: 30 additions & 24 deletions _api/datapi/Collection.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,16 +8,16 @@
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />

<title>datapi.Collection &#8212; datapi 0.1.1 documentation</title>
<title>datapi.Collection &#8212; datapi 0.1.2 documentation</title>



<script data-cfasync="false">
document.documentElement.dataset.mode = localStorage.getItem("mode") || "";
document.documentElement.dataset.theme = localStorage.getItem("theme") || "";
</script>
<!--
this give us a css class that will be invisible only if js is disabled
<!--
this give us a css class that will be invisible only if js is disabled
-->
<noscript>
<style>
Expand All @@ -27,19 +27,19 @@
</noscript>

<!-- Loaded before other Sphinx assets -->
<link href="../../_static/styles/theme.css?digest=26a4bc78f4c0ddb94549" rel="stylesheet" />
<link href="../../_static/styles/pydata-sphinx-theme.css?digest=26a4bc78f4c0ddb94549" rel="stylesheet" />
<link href="../../_static/styles/theme.css?digest=8878045cc6db502f8baf" rel="stylesheet" />
<link href="../../_static/styles/pydata-sphinx-theme.css?digest=8878045cc6db502f8baf" rel="stylesheet" />

<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=a746c00c" />
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=8f2a1f02" />
<link rel="stylesheet" type="text/css" href="../../_static/graphviz.css?v=4ae1632d" />

<!-- So that users can add custom icons -->
<script src="../../_static/scripts/fontawesome.js?digest=26a4bc78f4c0ddb94549"></script>
<script src="../../_static/scripts/fontawesome.js?digest=8878045cc6db502f8baf"></script>
<!-- Pre-loaded scripts that we'll load fully later -->
<link rel="preload" as="script" href="../../_static/scripts/bootstrap.js?digest=26a4bc78f4c0ddb94549" />
<link rel="preload" as="script" href="../../_static/scripts/pydata-sphinx-theme.js?digest=26a4bc78f4c0ddb94549" />
<link rel="preload" as="script" href="../../_static/scripts/bootstrap.js?digest=8878045cc6db502f8baf" />
<link rel="preload" as="script" href="../../_static/scripts/pydata-sphinx-theme.js?digest=8878045cc6db502f8baf" />

<script src="../../_static/documentation_options.js?v=a58bc63e"></script>
<script src="../../_static/documentation_options.js?v=92734c54"></script>
<script src="../../_static/doctools.js?v=9bcbadda"></script>
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
<script>DOCUMENTATION_OPTIONS.pagename = '_api/datapi/Collection';</script>
Expand All @@ -49,7 +49,7 @@
<link rel="prev" title="datapi.ApiClient" href="ApiClient.html" />
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="docsearch:language" content="en"/>
<meta name="docsearch:version" content="0.1.1" />
<meta name="docsearch:version" content="0.1.2" />
</head>


Expand Down Expand Up @@ -111,7 +111,7 @@



<p class="title logo__title">datapi 0.1.1 documentation</p>
<p class="title logo__title">datapi 0.1.2 documentation</p>

</a></div>

Expand Down Expand Up @@ -266,9 +266,14 @@


<div class="sidebar-primary-items__end sidebar-primary__section">
<div class="sidebar-primary-item">
<div id="ethical-ad-placement"
class="flat"
data-ea-publisher="readthedocs"
data-ea-type="readthedocs-sidebar"
data-ea-manual="true">
</div></div>
</div>

<div id="rtd-footer-container"></div>


</div>
Expand Down Expand Up @@ -442,13 +447,13 @@ <h1>datapi.Collection<a class="headerlink" href="#datapi-collection" title="Link
</nav></div>

<div class="sidebar-secondary-item">

<div class="tocsection sourcelink">
<a href="../../_sources/_api/datapi/Collection.rst.txt">
<i class="fa-solid fa-file-lines"></i> Show Source
</a>
</div>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../../_sources/_api/datapi/Collection.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div></div>

</div></div>

Expand All @@ -463,8 +468,8 @@ <h1>datapi.Collection<a class="headerlink" href="#datapi-collection" title="Link
</div>

<!-- Scripts loaded after <body> so the DOM is not blocked -->
<script defer src="../../_static/scripts/bootstrap.js?digest=26a4bc78f4c0ddb94549"></script>
<script defer src="../../_static/scripts/pydata-sphinx-theme.js?digest=26a4bc78f4c0ddb94549"></script>
<script defer src="../../_static/scripts/bootstrap.js?digest=8878045cc6db502f8baf"></script>
<script defer src="../../_static/scripts/pydata-sphinx-theme.js?digest=8878045cc6db502f8baf"></script>

<footer class="bd-footer">
<div class="bd-footer__inner bd-page-width">
Expand Down Expand Up @@ -497,7 +502,8 @@ <h1>datapi.Collection<a class="headerlink" href="#datapi-collection" title="Link

<div class="footer-item">
<p class="theme-version">
Built with the <a href="https://pydata-sphinx-theme.readthedocs.io/en/stable/index.html">PyData Sphinx Theme</a> 0.16.0.
<!-- # L10n: Setting the PST URL as an argument as this does not need to be localized -->
Built with the <a href="https://pydata-sphinx-theme.readthedocs.io/en/stable/index.html">PyData Sphinx Theme</a> 0.16.1.
</p></div>

</div>
Expand Down
Loading

0 comments on commit 964b535

Please sign in to comment.