Skip to content
Snippets Groups Projects
Commit 168a1a5c authored by safer-lgtm's avatar safer-lgtm
Browse files

docs HTML generated and data transformed

parent ab308de7
No related branches found
No related tags found
No related merge requests found
Hide whitespace changes
Inline Side-by-side
Showing
with 1209 additions and 9 deletions
docs/docHTMLs/generated/sample.html 0 → 100644
+ 88
− 0
View file @ 168a1a5c
<!DOCTYPE html>
<html lang="en" data-content_root="../">
<head>
<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>sample &#8212; sample v0.0.1 documentation</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="../_static/classic.css?v=def86cc0" />
<script src="../_static/documentation_options.js?v=2fea6348"></script>
<script src="../_static/doctools.js?v=9a2dae69"></script>
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
</head><body>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html">sample v0.0.1 documentation</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">sample</a></li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="sample">
<h1>sample<a class="headerlink" href="#sample" title="Link to this heading"></a></h1>
</section>
<div class="clearer"></div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/generated/sample.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<search id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="../search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</search>
<script>document.getElementById('searchbox').style.display = "block"</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html">sample v0.0.1 documentation</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">sample</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">
&#169; Copyright 2012, Kenneth Reitz.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.3.7.
</div>
</body>
</html>
\ No newline at end of file
docs/docHTMLs/genindex.html 0 → 100644
+ 185
− 0
View file @ 168a1a5c
<!DOCTYPE html>
<html lang="en" data-content_root="./">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Index &#8212; sample v0.0.1 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="_static/classic.css?v=def86cc0" />
<script src="_static/documentation_options.js?v=2fea6348"></script>
<script src="_static/doctools.js?v=9a2dae69"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<link rel="index" title="Index" href="#" />
<link rel="search" title="Search" href="search.html" />
</head><body>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="#" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">sample v0.0.1 documentation</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">Index</a></li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<h1 id="index">Index</h1>
<div class="genindex-jumpbox">
<a href="#D"><strong>D</strong></a>
| <a href="#G"><strong>G</strong></a>
| <a href="#L"><strong>L</strong></a>
| <a href="#M"><strong>M</strong></a>
| <a href="#Q"><strong>Q</strong></a>
| <a href="#T"><strong>T</strong></a>
</div>
<h2 id="D">D</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="dynamodb.html#dynamodb.core.DecimalEncoder">DecimalEncoder (class in dynamodb.core)</a>
</li>
<li><a href="dynamodb.html#dynamodb.core.DecimalEncoder.default">default() (dynamodb.core.DecimalEncoder method)</a>
</li>
<li>
dynamodb
<ul>
<li><a href="dynamodb.html#module-dynamodb">module</a>
</li>
</ul></li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li>
dynamodb.core
<ul>
<li><a href="dynamodb.html#module-dynamodb.core">module</a>
</li>
</ul></li>
<li>
dynamodb.dynamodb_helpers
<ul>
<li><a href="dynamodb.html#module-dynamodb.dynamodb_helpers">module</a>, <a href="generated/dynamodb.dynamodb_helpers.html#module-dynamodb.dynamodb_helpers">[1]</a>
</li>
</ul></li>
</ul></td>
</tr></table>
<h2 id="G">G</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="dynamodb.html#dynamodb.dynamodb_helpers.get_config">get_config() (in module dynamodb.dynamodb_helpers)</a>
</li>
<li><a href="dynamodb.html#dynamodb.dynamodb_helpers.get_dynamodb_resource">get_dynamodb_resource() (in module dynamodb.dynamodb_helpers)</a>, <a href="usage.html#dynamodb.dynamodb_helpers.get_dynamodb_resource">[1]</a>
</li>
<li><a href="dynamodb.html#dynamodb.dynamodb_helpers.get_movie_item">get_movie_item() (in module dynamodb.dynamodb_helpers)</a>, <a href="usage.html#dynamodb.dynamodb_helpers.get_movie_item">[1]</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="dynamodb.html#dynamodb.dynamodb_helpers.get_movies_table">get_movies_table() (in module dynamodb.dynamodb_helpers)</a>, <a href="usage.html#dynamodb.dynamodb_helpers.get_movies_table">[1]</a>
</li>
<li><a href="dynamodb.html#dynamodb.dynamodb_helpers.get_path_to_data">get_path_to_data() (in module dynamodb.dynamodb_helpers)</a>, <a href="usage.html#dynamodb.dynamodb_helpers.get_path_to_data">[1]</a>
</li>
<li><a href="dynamodb.html#dynamodb.dynamodb_helpers.get_raw_data_path">get_raw_data_path() (in module dynamodb.dynamodb_helpers)</a>, <a href="usage.html#dynamodb.dynamodb_helpers.get_raw_data_path">[1]</a>
</li>
<li><a href="dynamodb.html#dynamodb.dynamodb_helpers.get_tidy_data_path">get_tidy_data_path() (in module dynamodb.dynamodb_helpers)</a>, <a href="usage.html#dynamodb.dynamodb_helpers.get_tidy_data_path">[1]</a>
</li>
</ul></td>
</tr></table>
<h2 id="L">L</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="dynamodb.html#dynamodb.dynamodb_helpers.list_dynamodb_tables">list_dynamodb_tables() (in module dynamodb.dynamodb_helpers)</a>, <a href="usage.html#dynamodb.dynamodb_helpers.list_dynamodb_tables">[1]</a>
</li>
</ul></td>
</tr></table>
<h2 id="M">M</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li>
module
<ul>
<li><a href="dynamodb.html#module-dynamodb">dynamodb</a>
</li>
<li><a href="dynamodb.html#module-dynamodb.core">dynamodb.core</a>
</li>
<li><a href="dynamodb.html#module-dynamodb.dynamodb_helpers">dynamodb.dynamodb_helpers</a>, <a href="generated/dynamodb.dynamodb_helpers.html#module-dynamodb.dynamodb_helpers">[1]</a>
</li>
</ul></li>
</ul></td>
</tr></table>
<h2 id="Q">Q</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="dynamodb.html#dynamodb.dynamodb_helpers.query_movies_by_year">query_movies_by_year() (in module dynamodb.dynamodb_helpers)</a>, <a href="usage.html#dynamodb.dynamodb_helpers.query_movies_by_year">[1]</a>
</li>
</ul></td>
</tr></table>
<h2 id="T">T</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="dynamodb.html#dynamodb.dynamodb_helpers.tidy_movie_data">tidy_movie_data() (in module dynamodb.dynamodb_helpers)</a>, <a href="usage.html#dynamodb.dynamodb_helpers.tidy_movie_data">[1]</a>
</li>
</ul></td>
</tr></table>
<div class="clearer"></div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<search id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</search>
<script>document.getElementById('searchbox').style.display = "block"</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="#" title="General Index"
>index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">sample v0.0.1 documentation</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">Index</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">
&#169; Copyright 2012, Kenneth Reitz.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.3.7.
</div>
</body>
</html>
\ No newline at end of file
docs/docHTMLs/index.html 0 → 100644
+ 161
− 0
View file @ 168a1a5c
<!DOCTYPE html>
<html lang="en" data-content_root="./">
<head>
<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>Welcome to sample’s documentation! &#8212; sample v0.0.1 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="_static/classic.css?v=def86cc0" />
<script src="_static/documentation_options.js?v=2fea6348"></script>
<script src="_static/doctools.js?v=9a2dae69"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="formulaone" href="modules.html" />
</head><body>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="modules.html" title="formulaone"
accesskey="N">next</a> |</li>
<li class="nav-item nav-item-0"><a href="#">sample v0.0.1 documentation</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">Welcome to sample’s documentation!</a></li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="welcome-to-sample-s-documentation">
<h1>Welcome to sample’s documentation!<a class="headerlink" href="#welcome-to-sample-s-documentation" title="Link to this heading"></a></h1>
<p>Contents:</p>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="modules.html">formulaone</a><ul>
<li class="toctree-l2"><a class="reference internal" href="dynamodb.html">dynamodb package</a><ul>
<li class="toctree-l3"><a class="reference internal" href="dynamodb.html#submodules">Submodules</a></li>
<li class="toctree-l3"><a class="reference internal" href="dynamodb.html#module-dynamodb.core">dynamodb.core module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="dynamodb.html#dynamodb.core.DecimalEncoder"><code class="docutils literal notranslate"><span class="pre">DecimalEncoder</span></code></a><ul>
<li class="toctree-l5"><a class="reference internal" href="dynamodb.html#dynamodb.core.DecimalEncoder.default"><code class="docutils literal notranslate"><span class="pre">DecimalEncoder.default()</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="dynamodb.html#module-dynamodb.dynamodb_helpers">dynamodb.dynamodb_helpers module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="dynamodb.html#dynamodb.dynamodb_helpers.get_config"><code class="docutils literal notranslate"><span class="pre">get_config()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="dynamodb.html#dynamodb.dynamodb_helpers.get_dynamodb_resource"><code class="docutils literal notranslate"><span class="pre">get_dynamodb_resource()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="dynamodb.html#dynamodb.dynamodb_helpers.get_movie_item"><code class="docutils literal notranslate"><span class="pre">get_movie_item()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="dynamodb.html#dynamodb.dynamodb_helpers.get_movies_table"><code class="docutils literal notranslate"><span class="pre">get_movies_table()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="dynamodb.html#dynamodb.dynamodb_helpers.get_path_to_data"><code class="docutils literal notranslate"><span class="pre">get_path_to_data()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="dynamodb.html#dynamodb.dynamodb_helpers.get_raw_data_path"><code class="docutils literal notranslate"><span class="pre">get_raw_data_path()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="dynamodb.html#dynamodb.dynamodb_helpers.get_tidy_data_path"><code class="docutils literal notranslate"><span class="pre">get_tidy_data_path()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="dynamodb.html#dynamodb.dynamodb_helpers.list_dynamodb_tables"><code class="docutils literal notranslate"><span class="pre">list_dynamodb_tables()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="dynamodb.html#dynamodb.dynamodb_helpers.query_movies_by_year"><code class="docutils literal notranslate"><span class="pre">query_movies_by_year()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="dynamodb.html#dynamodb.dynamodb_helpers.tidy_movie_data"><code class="docutils literal notranslate"><span class="pre">tidy_movie_data()</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="dynamodb.html#dynamodb-load-movies-module">dynamodb.load_movies module</a></li>
<li class="toctree-l3"><a class="reference internal" href="dynamodb.html#dynamodb-prepare-data-module">dynamodb.prepare_data module</a></li>
<li class="toctree-l3"><a class="reference internal" href="dynamodb.html#dynamodb-tidy-data-module">dynamodb.tidy_data module</a></li>
<li class="toctree-l3"><a class="reference internal" href="dynamodb.html#module-dynamodb">Module contents</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="usage.html">Usage</a><ul>
<li class="toctree-l2"><a class="reference internal" href="usage.html#helpers">Helpers</a><ul>
<li class="toctree-l3"><a class="reference internal" href="usage.html#dynamodb.dynamodb_helpers.get_path_to_data"><code class="docutils literal notranslate"><span class="pre">get_path_to_data()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="usage.html#dynamodb.dynamodb_helpers.get_raw_data_path"><code class="docutils literal notranslate"><span class="pre">get_raw_data_path()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="usage.html#dynamodb.dynamodb_helpers.get_tidy_data_path"><code class="docutils literal notranslate"><span class="pre">get_tidy_data_path()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="usage.html#dynamodb">DynamoDB</a><ul>
<li class="toctree-l3"><a class="reference internal" href="usage.html#dynamodb.dynamodb_helpers.get_dynamodb_resource"><code class="docutils literal notranslate"><span class="pre">get_dynamodb_resource()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="usage.html#dynamodb.dynamodb_helpers.list_dynamodb_tables"><code class="docutils literal notranslate"><span class="pre">list_dynamodb_tables()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="usage.html#dynamodb.dynamodb_helpers.get_movies_table"><code class="docutils literal notranslate"><span class="pre">get_movies_table()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="usage.html#dynamodb.dynamodb_helpers.get_movie_item"><code class="docutils literal notranslate"><span class="pre">get_movie_item()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="usage.html#dynamodb.dynamodb_helpers.query_movies_by_year"><code class="docutils literal notranslate"><span class="pre">query_movies_by_year()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="usage.html#data-transformation">Data Transformation</a><ul>
<li class="toctree-l3"><a class="reference internal" href="usage.html#dynamodb.dynamodb_helpers.tidy_movie_data"><code class="docutils literal notranslate"><span class="pre">tidy_movie_data()</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="API.html">API</a><ul>
<li class="toctree-l2"><a class="reference internal" href="generated/dynamodb.dynamodb_helpers.html">dynamodb.dynamodb_helpers</a></li>
</ul>
</li>
</ul>
</div>
</section>
<div class="clearer"></div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<div>
<h4>Next topic</h4>
<p class="topless"><a href="modules.html"
title="next chapter">formulaone</a></p>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/index.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<search id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</search>
<script>document.getElementById('searchbox').style.display = "block"</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="modules.html" title="formulaone"
>next</a> |</li>
<li class="nav-item nav-item-0"><a href="#">sample v0.0.1 documentation</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">Welcome to sample’s documentation!</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">
&#169; Copyright 2012, Kenneth Reitz.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.3.7.
</div>
</body>
</html>
\ No newline at end of file
docs/docHTMLs/modules.html 0 → 100644
+ 144
− 0
View file @ 168a1a5c
<!DOCTYPE html>
<html lang="en" data-content_root="./">
<head>
<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>formulaone &#8212; sample v0.0.1 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="_static/classic.css?v=def86cc0" />
<script src="_static/documentation_options.js?v=2fea6348"></script>
<script src="_static/doctools.js?v=9a2dae69"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="dynamodb package" href="dynamodb.html" />
<link rel="prev" title="Welcome to sample’s documentation!" href="index.html" />
</head><body>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="dynamodb.html" title="dynamodb package"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="index.html" title="Welcome to sample’s documentation!"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">sample v0.0.1 documentation</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">formulaone</a></li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="formulaone">
<h1>formulaone<a class="headerlink" href="#formulaone" title="Link to this heading"></a></h1>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="dynamodb.html">dynamodb package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="dynamodb.html#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="dynamodb.html#module-dynamodb.core">dynamodb.core module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="dynamodb.html#dynamodb.core.DecimalEncoder"><code class="docutils literal notranslate"><span class="pre">DecimalEncoder</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="dynamodb.html#dynamodb.core.DecimalEncoder.default"><code class="docutils literal notranslate"><span class="pre">DecimalEncoder.default()</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="dynamodb.html#module-dynamodb.dynamodb_helpers">dynamodb.dynamodb_helpers module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="dynamodb.html#dynamodb.dynamodb_helpers.get_config"><code class="docutils literal notranslate"><span class="pre">get_config()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="dynamodb.html#dynamodb.dynamodb_helpers.get_dynamodb_resource"><code class="docutils literal notranslate"><span class="pre">get_dynamodb_resource()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="dynamodb.html#dynamodb.dynamodb_helpers.get_movie_item"><code class="docutils literal notranslate"><span class="pre">get_movie_item()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="dynamodb.html#dynamodb.dynamodb_helpers.get_movies_table"><code class="docutils literal notranslate"><span class="pre">get_movies_table()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="dynamodb.html#dynamodb.dynamodb_helpers.get_path_to_data"><code class="docutils literal notranslate"><span class="pre">get_path_to_data()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="dynamodb.html#dynamodb.dynamodb_helpers.get_raw_data_path"><code class="docutils literal notranslate"><span class="pre">get_raw_data_path()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="dynamodb.html#dynamodb.dynamodb_helpers.get_tidy_data_path"><code class="docutils literal notranslate"><span class="pre">get_tidy_data_path()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="dynamodb.html#dynamodb.dynamodb_helpers.list_dynamodb_tables"><code class="docutils literal notranslate"><span class="pre">list_dynamodb_tables()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="dynamodb.html#dynamodb.dynamodb_helpers.query_movies_by_year"><code class="docutils literal notranslate"><span class="pre">query_movies_by_year()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="dynamodb.html#dynamodb.dynamodb_helpers.tidy_movie_data"><code class="docutils literal notranslate"><span class="pre">tidy_movie_data()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="dynamodb.html#dynamodb-load-movies-module">dynamodb.load_movies module</a></li>
<li class="toctree-l2"><a class="reference internal" href="dynamodb.html#dynamodb-prepare-data-module">dynamodb.prepare_data module</a></li>
<li class="toctree-l2"><a class="reference internal" href="dynamodb.html#dynamodb-tidy-data-module">dynamodb.tidy_data module</a></li>
<li class="toctree-l2"><a class="reference internal" href="dynamodb.html#module-dynamodb">Module contents</a></li>
</ul>
</li>
</ul>
</div>
</section>
<div class="clearer"></div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="index.html"
title="previous chapter">Welcome to sample’s documentation!</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="dynamodb.html"
title="next chapter">dynamodb package</a></p>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/modules.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<search id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</search>
<script>document.getElementById('searchbox').style.display = "block"</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="dynamodb.html" title="dynamodb package"
>next</a> |</li>
<li class="right" >
<a href="index.html" title="Welcome to sample’s documentation!"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">sample v0.0.1 documentation</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">formulaone</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">
&#169; Copyright 2012, Kenneth Reitz.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.3.7.
</div>
</body>
</html>
\ No newline at end of file
docs/docHTMLs/objects.inv 0 → 100644
+ 8
− 0
View file @ 168a1a5c
# Sphinx inventory version 2
# Project: sample
# Version: v0.0.1
# The remainder of this file is compressed using zlib.
xڥn0|
Nrͭ@s!"Q墒$5z}JlS^b:(%;ʜ7Cl;.G"G/!+R?QԣVB~p.s)VQЀTY9b*T :?^Ad"KLXSPhښ ѡk=x)LۗPϦ W4@UF6@050pj''-쒿Em6<]
p~Wܓ|V=_/)'zz*CW G5-z7cPe]ʹtI7ۗwH?'܃nq9kviL
Z& FW֘l6I"~V#';xǵ p~#jYOE:io4:*Y:Sa3- 41bί_6D*i7$yX䠂
\ No newline at end of file
docs/docHTMLs/py-modindex.html 0 → 100644
+ 108
− 0
View file @ 168a1a5c
<!DOCTYPE html>
<html lang="en" data-content_root="./">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Python Module Index &#8212; sample v0.0.1 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="_static/classic.css?v=def86cc0" />
<script src="_static/documentation_options.js?v=2fea6348"></script>
<script src="_static/doctools.js?v=9a2dae69"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
</head><body>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="#" title="Python Module Index"
>modules</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">sample v0.0.1 documentation</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">Python Module Index</a></li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<h1>Python Module Index</h1>
<div class="modindex-jumpbox">
<a href="#cap-d"><strong>d</strong></a>
</div>
<table class="indextable modindextable">
<tr class="pcap"><td></td><td>&#160;</td><td></td></tr>
<tr class="cap" id="cap-d"><td></td><td>
<strong>d</strong></td><td></td></tr>
<tr>
<td><img src="_static/minus.png" class="toggler"
id="toggle-1" style="display: none" alt="-" /></td>
<td>
<a href="dynamodb.html#module-dynamodb"><code class="xref">dynamodb</code></a></td><td>
<em></em></td></tr>
<tr class="cg-1">
<td></td>
<td>&#160;&#160;&#160;
<a href="dynamodb.html#module-dynamodb.core"><code class="xref">dynamodb.core</code></a></td><td>
<em></em></td></tr>
<tr class="cg-1">
<td></td>
<td>&#160;&#160;&#160;
<a href="generated/dynamodb.dynamodb_helpers.html#module-dynamodb.dynamodb_helpers"><code class="xref">dynamodb.dynamodb_helpers</code></a></td><td>
<em></em></td></tr>
</table>
<div class="clearer"></div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<search id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</search>
<script>document.getElementById('searchbox').style.display = "block"</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="#" title="Python Module Index"
>modules</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">sample v0.0.1 documentation</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">Python Module Index</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">
&#169; Copyright 2012, Kenneth Reitz.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.3.7.
</div>
</body>
</html>
\ No newline at end of file
docs/docHTMLs/search.html 0 → 100644
+ 100
− 0
View file @ 168a1a5c
<!DOCTYPE html>
<html lang="en" data-content_root="./">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Search &#8212; sample v0.0.1 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="_static/classic.css?v=def86cc0" />
<script src="_static/documentation_options.js?v=2fea6348"></script>
<script src="_static/doctools.js?v=9a2dae69"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/searchtools.js"></script>
<script src="_static/language_data.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="#" />
<script src="searchindex.js" defer="defer"></script>
<meta name="robots" content="noindex" />
</head><body>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">sample v0.0.1 documentation</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">Search</a></li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<h1 id="search-documentation">Search</h1>
<noscript>
<div class="admonition warning">
<p>
Please activate JavaScript to enable the search
functionality.
</p>
</div>
</noscript>
<p>
Searching for multiple words only shows matches that contain
all words.
</p>
<form action="" method="get">
<input type="text" name="q" aria-labelledby="search-documentation" value="" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="search" />
<span id="search-progress" style="padding-left: 10px"></span>
</form>
<div id="search-results"></div>
<div class="clearer"></div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">sample v0.0.1 documentation</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">Search</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">
&#169; Copyright 2012, Kenneth Reitz.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.3.7.
</div>
</body>
</html>
\ No newline at end of file
docs/docHTMLs/searchindex.js 0 → 100644
+ 1
− 0
View file @ 168a1a5c
Search.setIndex({"alltitles": {"API": [[0, "api"]], "Data Transformation": [[8, "data-transformation"]], "DynamoDB": [[8, "dynamodb"]], "Ergast API Interface": [[3, "ergast-api-interface"]], "Helpers": [[8, "helpers"]], "Introduction": [[3, "introduction"]], "Module contents": [[1, "module-dynamodb"]], "Submodules": [[1, "submodules"]], "Usage": [[8, "usage"]], "Welcome to sample\u2019s documentation!": [[6, "welcome-to-sample-s-documentation"]], "dynamodb package": [[1, "dynamodb-package"]], "dynamodb.core module": [[1, "module-dynamodb.core"]], "dynamodb.dynamodb_helpers": [[2, "module-dynamodb.dynamodb_helpers"]], "dynamodb.dynamodb_helpers module": [[1, "module-dynamodb.dynamodb_helpers"]], "dynamodb.load_movies module": [[1, "dynamodb-load-movies-module"]], "dynamodb.prepare_data module": [[1, "dynamodb-prepare-data-module"]], "dynamodb.tidy_data module": [[1, "dynamodb-tidy-data-module"]], "formulaone": [[7, "formulaone"]], "sample": [[4, "sample"]], "sample.helpers": [[5, "sample-helpers"]]}, "docnames": ["API", "dynamodb", "generated/dynamodb.dynamodb_helpers", "generated/ergast", "generated/sample", "generated/sample.helpers", "index", "modules", "usage"], "envversion": {"sphinx": 61, "sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2}, "filenames": ["API.rst", "dynamodb.rst", "generated/dynamodb.dynamodb_helpers.rst", "generated/ergast.rst", "generated/sample.rst", "generated/sample.helpers.rst", "index.rst", "modules.rst", "usage.rst"], "indexentries": {"decimalencoder (class in dynamodb.core)": [[1, "dynamodb.core.DecimalEncoder", false]], "default() (dynamodb.core.decimalencoder method)": [[1, "dynamodb.core.DecimalEncoder.default", false]], "dynamodb": [[1, "module-dynamodb", false]], "dynamodb.core": [[1, "module-dynamodb.core", false]], "dynamodb.dynamodb_helpers": [[1, "module-dynamodb.dynamodb_helpers", false], [2, "module-dynamodb.dynamodb_helpers", false]], "get_config() (in module dynamodb.dynamodb_helpers)": [[1, "dynamodb.dynamodb_helpers.get_config", false]], "get_dynamodb_resource() (in module dynamodb.dynamodb_helpers)": [[1, "dynamodb.dynamodb_helpers.get_dynamodb_resource", false], [8, "dynamodb.dynamodb_helpers.get_dynamodb_resource", false]], "get_movie_item() (in module dynamodb.dynamodb_helpers)": [[1, "dynamodb.dynamodb_helpers.get_movie_item", false], [8, "dynamodb.dynamodb_helpers.get_movie_item", false]], "get_movies_table() (in module dynamodb.dynamodb_helpers)": [[1, "dynamodb.dynamodb_helpers.get_movies_table", false], [8, "dynamodb.dynamodb_helpers.get_movies_table", false]], "get_path_to_data() (in module dynamodb.dynamodb_helpers)": [[1, "dynamodb.dynamodb_helpers.get_path_to_data", false], [8, "dynamodb.dynamodb_helpers.get_path_to_data", false]], "get_raw_data_path() (in module dynamodb.dynamodb_helpers)": [[1, "dynamodb.dynamodb_helpers.get_raw_data_path", false], [8, "dynamodb.dynamodb_helpers.get_raw_data_path", false]], "get_tidy_data_path() (in module dynamodb.dynamodb_helpers)": [[1, "dynamodb.dynamodb_helpers.get_tidy_data_path", false], [8, "dynamodb.dynamodb_helpers.get_tidy_data_path", false]], "list_dynamodb_tables() (in module dynamodb.dynamodb_helpers)": [[1, "dynamodb.dynamodb_helpers.list_dynamodb_tables", false], [8, "dynamodb.dynamodb_helpers.list_dynamodb_tables", false]], "module": [[1, "module-dynamodb", false], [1, "module-dynamodb.core", false], [1, "module-dynamodb.dynamodb_helpers", false], [2, "module-dynamodb.dynamodb_helpers", false]], "query_movies_by_year() (in module dynamodb.dynamodb_helpers)": [[1, "dynamodb.dynamodb_helpers.query_movies_by_year", false], [8, "dynamodb.dynamodb_helpers.query_movies_by_year", false]], "tidy_movie_data() (in module dynamodb.dynamodb_helpers)": [[1, "dynamodb.dynamodb_helpers.tidy_movie_data", false], [8, "dynamodb.dynamodb_helpers.tidy_movie_data", false]]}, "objects": {"": [[1, 0, 0, "-", "dynamodb"]], "dynamodb": [[1, 0, 0, "-", "core"], [2, 0, 0, "-", "dynamodb_helpers"]], "dynamodb.core": [[1, 1, 1, "", "DecimalEncoder"]], "dynamodb.core.DecimalEncoder": [[1, 2, 1, "", "default"]], "dynamodb.dynamodb_helpers": [[1, 3, 1, "", "get_config"], [8, 3, 1, "", "get_dynamodb_resource"], [8, 3, 1, "", "get_movie_item"], [8, 3, 1, "", "get_movies_table"], [8, 3, 1, "", "get_path_to_data"], [8, 3, 1, "", "get_raw_data_path"], [8, 3, 1, "", "get_tidy_data_path"], [8, 3, 1, "", "list_dynamodb_tables"], [8, 3, 1, "", "query_movies_by_year"], [8, 3, 1, "", "tidy_movie_data"]]}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "method", "Python method"], "3": ["py", "function", "Python function"]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:method", "3": "py:function"}, "terms": {"For": [1, 3], "The": [1, 3, 8], "To": 8, "access": 3, "all": [1, 3, 8], "allow_nan": 1, "also": 8, "api": 6, "appli": 3, "ar": 3, "arbitrari": 1, "arg": [1, 8], "aw": [1, 8], "base": 1, "cach": 3, "call": 1, "can": [3, 8], "care": 3, "check_circular": 1, "class": 1, "com": 3, "config": 1, "configur": 1, "contain": [1, 8], "content": [6, 7], "core": [6, 7], "could": 1, "creat": [1, 8], "data": [1, 6], "datafram": [1, 8], "decimalencod": [1, 6, 7], "def": 1, "default": [1, 6, 7], "dict": [1, 8], "dynamo_resourc": [1, 8], "dynamodb": [6, 7], "dynamodb_help": [6, 7, 8], "els": 1, "endpoint": 3, "enforc": 3, "ensure_ascii": 1, "especi": 3, "exampl": 1, "exce": 3, "except": 1, "f1": 3, "fals": 1, "fastf1": 3, "file": 1, "folder": 8, "formulaon": 6, "from": [1, 8], "function": [2, 8], "get": [1, 8], "get_config": [1, 6, 7], "get_dynamodb_resourc": [1, 6, 7, 8], "get_movie_item": [1, 6, 7, 8], "get_movies_t": [1, 6, 7, 8], "get_path_to_data": [1, 6, 7, 8], "get_raw_data_path": [1, 6, 7, 8], "get_tidy_data_path": [1, 6, 7, 8], "given": [1, 8], "handl": 3, "helper": 6, "how": 3, "http": 3, "i": 8, "implement": 1, "indent": 1, "inform": 3, "item": [1, 8], "iter": 1, "jsonencod": 1, "know": 3, "let": 1, "like": 1, "limit": 3, "list": [1, 8], "list_dynamodb_t": [1, 6, 7, 8], "load_movi": [6, 7], "make": 3, "method": 1, "modul": [3, 6, 7], "more": 3, "movi": [1, 8], "mrd": 3, "name": [1, 8], "none": 1, "o": 1, "obj": 1, "object": [1, 3], "packag": [6, 7], "pass": 1, "path": [1, 8], "possibl": 3, "prepare_data": [6, 7], "provid": 3, "queri": [1, 8], "query_movies_by_year": [1, 6, 7, 8], "rais": 1, "rate": 3, "raw": [1, 8], "read": 1, "request": 3, "resourc": [1, 8], "return": [1, 8], "see": 3, "self": 1, "separ": 1, "serializ": 1, "session": [1, 8], "skipkei": 1, "sort_kei": 1, "specif": 8, "specifi": 3, "subclass": 1, "submodul": [6, 7], "support": [1, 3], "sure": 3, "tabl": [1, 8], "take": 3, "term": 3, "thi": [1, 3], "tidi": [1, 8], "tidy_data": [6, 7], "tidy_movie_data": [1, 6, 7, 8], "titl": [1, 8], "transform": [1, 6], "true": 1, "try": [1, 3], "typeerror": 1, "us": [1, 3, 8], "usag": 6, "what": 3, "where": 3, "year": [1, 8], "you": [1, 8]}, "titles": ["API", "dynamodb package", "dynamodb.dynamodb_helpers", "Ergast API Interface", "sample", "sample.helpers", "Welcome to sample\u2019s documentation!", "formulaone", "Usage"], "titleterms": {"": 6, "api": [0, 3], "content": 1, "core": 1, "data": 8, "document": 6, "dynamodb": [1, 2, 8], "dynamodb_help": [1, 2], "ergast": 3, "formulaon": 7, "helper": [5, 8], "interfac": 3, "introduct": 3, "load_movi": 1, "modul": 1, "packag": 1, "prepare_data": 1, "sampl": [4, 5, 6], "submodul": 1, "tidy_data": 1, "transform": 8, "usag": 8, "welcom": 6}})
\ No newline at end of file
docs/docHTMLs/usage.html 0 → 100644
+ 248
− 0
View file @ 168a1a5c
<!DOCTYPE html>
<html lang="en" data-content_root="./">
<head>
<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>Usage &#8212; sample v0.0.1 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="_static/classic.css?v=def86cc0" />
<script src="_static/documentation_options.js?v=2fea6348"></script>
<script src="_static/doctools.js?v=9a2dae69"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="API" href="API.html" />
<link rel="prev" title="dynamodb package" href="dynamodb.html" />
</head><body>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="API.html" title="API"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="dynamodb.html" title="dynamodb package"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">sample v0.0.1 documentation</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">Usage</a></li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="usage">
<h1>Usage<a class="headerlink" href="#usage" title="Link to this heading"></a></h1>
<section id="helpers">
<h2>Helpers<a class="headerlink" href="#helpers" title="Link to this heading"></a></h2>
<p>You can use the <code class="docutils literal notranslate"><span class="pre">dynamodb.dynamodb_helpers.get_path_to_data()</span></code> function:</p>
<dl class="py function">
<dt class="sig sig-object py" id="dynamodb.dynamodb_helpers.get_path_to_data">
<span class="sig-prename descclassname"><span class="pre">dynamodb.dynamodb_helpers.</span></span><span class="sig-name descname"><span class="pre">get_path_to_data</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#dynamodb.dynamodb_helpers.get_path_to_data" title="Link to this definition"></a></dt>
<dd><p>Return path to data.</p>
</dd></dl>
<p>Raw data folder is returned by <code class="docutils literal notranslate"><span class="pre">dynamodb.dynamodb_helpers.get_raw_data_path()</span></code> function:</p>
<dl class="py function">
<dt class="sig sig-object py" id="dynamodb.dynamodb_helpers.get_raw_data_path">
<span class="sig-prename descclassname"><span class="pre">dynamodb.dynamodb_helpers.</span></span><span class="sig-name descname"><span class="pre">get_raw_data_path</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#dynamodb.dynamodb_helpers.get_raw_data_path" title="Link to this definition"></a></dt>
<dd><p>Return path to raw data.</p>
</dd></dl>
<p>You can also use the <code class="docutils literal notranslate"><span class="pre">dynamodb.dynamodb_helpers.get_tidy_data_path()</span></code> function:</p>
<dl class="py function">
<dt class="sig sig-object py" id="dynamodb.dynamodb_helpers.get_tidy_data_path">
<span class="sig-prename descclassname"><span class="pre">dynamodb.dynamodb_helpers.</span></span><span class="sig-name descname"><span class="pre">get_tidy_data_path</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#dynamodb.dynamodb_helpers.get_tidy_data_path" title="Link to this definition"></a></dt>
<dd><p>Return path to tidy data.</p>
</dd></dl>
</section>
<section id="dynamodb">
<h2>DynamoDB<a class="headerlink" href="#dynamodb" title="Link to this heading"></a></h2>
<p>To create a DynamoDB resource, use the <code class="docutils literal notranslate"><span class="pre">dynamodb.dynamodb_helpers.get_dynamodb_resource</span></code> function:</p>
<dl class="py function">
<dt class="sig sig-object py" id="dynamodb.dynamodb_helpers.get_dynamodb_resource">
<span class="sig-prename descclassname"><span class="pre">dynamodb.dynamodb_helpers.</span></span><span class="sig-name descname"><span class="pre">get_dynamodb_resource</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#dynamodb.dynamodb_helpers.get_dynamodb_resource" title="Link to this definition"></a></dt>
<dd><p>Creates a DynamoDB resource using the AWS session.</p>
<dl class="simple">
<dt>Returns:</dt><dd><p>dynamo_resource: The DynamoDB resource.</p>
</dd>
</dl>
</dd></dl>
<p>To list all DynamoDB tables, use the <code class="docutils literal notranslate"><span class="pre">dynamodb.dynamodb_helpers.list_dynamodb_tables</span></code> function:</p>
<dl class="py function">
<dt class="sig sig-object py" id="dynamodb.dynamodb_helpers.list_dynamodb_tables">
<span class="sig-prename descclassname"><span class="pre">dynamodb.dynamodb_helpers.</span></span><span class="sig-name descname"><span class="pre">list_dynamodb_tables</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dynamo_resource</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#dynamodb.dynamodb_helpers.list_dynamodb_tables" title="Link to this definition"></a></dt>
<dd><p>Lists all tables in the DynamoDB resource.</p>
<dl class="simple">
<dt>Args:</dt><dd><p>dynamo_resource: The DynamoDB resource.</p>
</dd>
<dt>Returns:</dt><dd><p>list: List of table names.</p>
</dd>
</dl>
</dd></dl>
<p>To get the movies table from DynamoDB, use the <code class="docutils literal notranslate"><span class="pre">dynamodb.dynamodb_helpers.get_movies_table</span></code> function:</p>
<dl class="py function">
<dt class="sig sig-object py" id="dynamodb.dynamodb_helpers.get_movies_table">
<span class="sig-prename descclassname"><span class="pre">dynamodb.dynamodb_helpers.</span></span><span class="sig-name descname"><span class="pre">get_movies_table</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dynamo_resource</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#dynamodb.dynamodb_helpers.get_movies_table" title="Link to this definition"></a></dt>
<dd><p>Gets the movies table from DynamoDB.</p>
<dl class="simple">
<dt>Args:</dt><dd><p>dynamo_resource: The DynamoDB resource.</p>
</dd>
<dt>Returns:</dt><dd><p>table: The DynamoDB table resource for movies.</p>
</dd>
</dl>
</dd></dl>
<p>To get a specific movie item, use the <code class="docutils literal notranslate"><span class="pre">dynamodb.dynamodb_helpers.get_movie_item</span></code> function:</p>
<dl class="py function">
<dt class="sig sig-object py" id="dynamodb.dynamodb_helpers.get_movie_item">
<span class="sig-prename descclassname"><span class="pre">dynamodb.dynamodb_helpers.</span></span><span class="sig-name descname"><span class="pre">get_movie_item</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">table</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">year</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">title</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#dynamodb.dynamodb_helpers.get_movie_item" title="Link to this definition"></a></dt>
<dd><p>Gets a movie item from the DynamoDB table.</p>
<dl class="simple">
<dt>Args:</dt><dd><p>table: The DynamoDB table resource.
year: The year of the movie.
title: The title of the movie.</p>
</dd>
<dt>Returns:</dt><dd><p>dict: The movie item.</p>
</dd>
</dl>
</dd></dl>
<p>To query movies by year, use the <code class="docutils literal notranslate"><span class="pre">dynamodb.dynamodb_helpers.query_movies_by_year</span></code> function:</p>
<dl class="py function">
<dt class="sig sig-object py" id="dynamodb.dynamodb_helpers.query_movies_by_year">
<span class="sig-prename descclassname"><span class="pre">dynamodb.dynamodb_helpers.</span></span><span class="sig-name descname"><span class="pre">query_movies_by_year</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">table</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">year</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#dynamodb.dynamodb_helpers.query_movies_by_year" title="Link to this definition"></a></dt>
<dd><p>Queries movies by year from the DynamoDB table.</p>
<dl class="simple">
<dt>Args:</dt><dd><p>table: The DynamoDB table resource.
year: The year to query.</p>
</dd>
<dt>Returns:</dt><dd><p>list: List of movies for the given year.</p>
</dd>
</dl>
</dd></dl>
</section>
<section id="data-transformation">
<h2>Data Transformation<a class="headerlink" href="#data-transformation" title="Link to this heading"></a></h2>
<p>To transform raw movie data into a tidy DataFrame, use the <code class="docutils literal notranslate"><span class="pre">dynamodb.dynamodb_helpers.tidy_movie_data</span></code> function:</p>
<dl class="py function">
<dt class="sig sig-object py" id="dynamodb.dynamodb_helpers.tidy_movie_data">
<span class="sig-prename descclassname"><span class="pre">dynamodb.dynamodb_helpers.</span></span><span class="sig-name descname"><span class="pre">tidy_movie_data</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">movies</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#dynamodb.dynamodb_helpers.tidy_movie_data" title="Link to this definition"></a></dt>
<dd><p>Transforms the raw movie data into a tidy DataFrame.</p>
<dl class="simple">
<dt>Args:</dt><dd><p>movies (list): List of raw movie data.</p>
</dd>
<dt>Returns:</dt><dd><p>DataFrame: Tidy DataFrame containing movie data.</p>
</dd>
</dl>
</dd></dl>
</section>
</section>
<div class="clearer"></div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<div>
<h3><a href="index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Usage</a><ul>
<li><a class="reference internal" href="#helpers">Helpers</a><ul>
<li><a class="reference internal" href="#dynamodb.dynamodb_helpers.get_path_to_data"><code class="docutils literal notranslate"><span class="pre">get_path_to_data()</span></code></a></li>
<li><a class="reference internal" href="#dynamodb.dynamodb_helpers.get_raw_data_path"><code class="docutils literal notranslate"><span class="pre">get_raw_data_path()</span></code></a></li>
<li><a class="reference internal" href="#dynamodb.dynamodb_helpers.get_tidy_data_path"><code class="docutils literal notranslate"><span class="pre">get_tidy_data_path()</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#dynamodb">DynamoDB</a><ul>
<li><a class="reference internal" href="#dynamodb.dynamodb_helpers.get_dynamodb_resource"><code class="docutils literal notranslate"><span class="pre">get_dynamodb_resource()</span></code></a></li>
<li><a class="reference internal" href="#dynamodb.dynamodb_helpers.list_dynamodb_tables"><code class="docutils literal notranslate"><span class="pre">list_dynamodb_tables()</span></code></a></li>
<li><a class="reference internal" href="#dynamodb.dynamodb_helpers.get_movies_table"><code class="docutils literal notranslate"><span class="pre">get_movies_table()</span></code></a></li>
<li><a class="reference internal" href="#dynamodb.dynamodb_helpers.get_movie_item"><code class="docutils literal notranslate"><span class="pre">get_movie_item()</span></code></a></li>
<li><a class="reference internal" href="#dynamodb.dynamodb_helpers.query_movies_by_year"><code class="docutils literal notranslate"><span class="pre">query_movies_by_year()</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#data-transformation">Data Transformation</a><ul>
<li><a class="reference internal" href="#dynamodb.dynamodb_helpers.tidy_movie_data"><code class="docutils literal notranslate"><span class="pre">tidy_movie_data()</span></code></a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="dynamodb.html"
title="previous chapter">dynamodb package</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="API.html"
title="next chapter">API</a></p>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/usage.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<search id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</search>
<script>document.getElementById('searchbox').style.display = "block"</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="API.html" title="API"
>next</a> |</li>
<li class="right" >
<a href="dynamodb.html" title="dynamodb package"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">sample v0.0.1 documentation</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">Usage</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">
&#169; Copyright 2012, Kenneth Reitz.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.3.7.
</div>
</body>
</html>
\ No newline at end of file
docs/dynamodb.rst 0 → 100644
+ 53
− 0
View file @ 168a1a5c
dynamodb package
================
Submodules
----------
dynamodb.core module
--------------------
.. automodule:: dynamodb.core
:members:
:undoc-members:
:show-inheritance:
dynamodb.dynamodb\_helpers module
---------------------------------
.. automodule:: dynamodb.dynamodb_helpers
:members:
:undoc-members:
:show-inheritance:
dynamodb.load\_movies module
----------------------------
.. automodule:: dynamodb.load_movies
:members:
:undoc-members:
:show-inheritance:
dynamodb.prepare\_data module
-----------------------------
.. automodule:: dynamodb.prepare_data
:members:
:undoc-members:
:show-inheritance:
dynamodb.tidy\_data module
--------------------------
.. automodule:: dynamodb.tidy_data
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: dynamodb
:members:
:undoc-members:
:show-inheritance:
docs/modules.rst
+ 1
− 1
View file @ 168a1a5c
......@@ -4,4 +4,4 @@ formulaone
.. toctree::
:maxdepth: 4
formulaone
dynamodb
docs/usage.rst
+ 37
− 7
View file @ 168a1a5c
......@@ -2,16 +2,46 @@ Usage
=====
Helpers
------------
-------
you can use the ``formulaone.helpers.get_path_to_data()`` function:
You can use the ``dynamodb.dynamodb_helpers.get_path_to_data()`` function:
.. autofunction:: formulaone.helpers.get_path_to_data
.. autofunction:: dynamodb.dynamodb_helpers.get_path_to_data
Raw data folder is returned by ``formulaone.helpers.get_raw_data_path()`` function:
Raw data folder is returned by ``dynamodb.dynamodb_helpers.get_raw_data_path()`` function:
.. autofunction:: formulaone.helpers.get_raw_data_path
.. autofunction:: dynamodb.dynamodb_helpers.get_raw_data_path
you can also use the ``formulaone.helpers.get_tidy_data_path()`` function:
You can also use the ``dynamodb.dynamodb_helpers.get_tidy_data_path()`` function:
.. autofunction:: formulaone.helpers.get_tidy_data_path
\ No newline at end of file
.. autofunction:: dynamodb.dynamodb_helpers.get_tidy_data_path
DynamoDB
--------
To create a DynamoDB resource, use the ``dynamodb.dynamodb_helpers.get_dynamodb_resource`` function:
.. autofunction:: dynamodb.dynamodb_helpers.get_dynamodb_resource
To list all DynamoDB tables, use the ``dynamodb.dynamodb_helpers.list_dynamodb_tables`` function:
.. autofunction:: dynamodb.dynamodb_helpers.list_dynamodb_tables
To get the movies table from DynamoDB, use the ``dynamodb.dynamodb_helpers.get_movies_table`` function:
.. autofunction:: dynamodb.dynamodb_helpers.get_movies_table
To get a specific movie item, use the ``dynamodb.dynamodb_helpers.get_movie_item`` function:
.. autofunction:: dynamodb.dynamodb_helpers.get_movie_item
To query movies by year, use the ``dynamodb.dynamodb_helpers.query_movies_by_year`` function:
.. autofunction:: dynamodb.dynamodb_helpers.query_movies_by_year
Data Transformation
-------------------
To transform raw movie data into a tidy DataFrame, use the ``dynamodb.dynamodb_helpers.tidy_movie_data`` function:
.. autofunction:: dynamodb.dynamodb_helpers.tidy_movie_data
dynamodb/Data/RawData/rawdata.json 0 → 100644
+ 1
− 0
View file @ 168a1a5c
{"year": 1994.0, "info": {"actors": ["Tim Robbins", "Morgan Freeman", "Bob Gunton"], "release_date": "1994-09-10T00:00:00Z", "plot": "Two imprisoned men bond over a number of years, finding solace and eventual redemption through acts of common decency.", "genres": ["Crime", "Drama"], "image_url": "http://ia.media-imdb.com/images/M/MV5BODU4MjU4NjIwNl5BMl5BanBnXkFtZTgwMDU2MjEyMDE@._V1_SX400_.jpg", "directors": ["Frank Darabont"], "rating": 9.3, "rank": 80.0, "running_time_secs": 8520.0}, "title": "The Shawshank Redemption"}
\ No newline at end of file
dynamodb/Data/TidyData/current_race.parquet 0 → 100644
+ 0
− 0
View file @ 168a1a5c
File added
formulaone/__init__.py → dynamodb/__init__.py
+ 0
− 0
View file @ 168a1a5c
File moved
dynamodb/core.py 0 → 100644
+ 13
− 0
View file @ 168a1a5c
# -*- coding: utf-8 -*-
import json
from decimal import Decimal
# Custom JSON Encoder for Decimal
class DecimalEncoder(json.JSONEncoder):
def default(self, obj):
if isinstance(obj, Decimal):
return float(obj)
return super(DecimalEncoder, self).default(obj)
\ No newline at end of file
formulaone/dynamodb_helpers.py → dynamodb/dynamodb_helpers.py
+ 19
− 0
View file @ 168a1a5c
......@@ -9,6 +9,25 @@ import pandas as pd
from decimal import Decimal
from pathlib import Path
def get_path_to_data():
"""Return path to data."""
return Path('Data/')
def get_raw_data_path():
"""Return path to raw data."""
return get_path_to_data() / 'RawData'
def get_tidy_data_path():
"""Return path to tidy data."""
return get_path_to_data() / 'TidyData'
def get_config():
"""
Reads the configuration file and returns the config object.
......
dynamodb/load_movies.py 0 → 100644
+ 21
− 0
View file @ 168a1a5c
import json
from dynamodb_helpers import *
from core import DecimalEncoder
dynamo_resource = get_dynamodb_resource()
movies_table = get_movies_table(dynamo_resource)
movie_item = get_movie_item(movies_table, 1994, "The Shawshank Redemption")
#movies_by_year = query_movies_by_year(movies_table, 1994)
# Load data from DynamoDB
raw_data_path = get_raw_data_path()
raw_data_path.mkdir(parents=True, exist_ok=True)
dec_encoder= DecimalEncoder()
# Save data in JSON
with open(raw_data_path / 'rawdata.json', 'w') as f:
json.dump(movie_item, f, cls=dec_encoder)
print(f"Movie data saved to {raw_data_path / 'rawdata.json'}")
\ No newline at end of file
formulaone/prepare_data.py → dynamodb/prepare_data.py
+ 1
− 1
View file @ 168a1a5c
......@@ -3,7 +3,7 @@ from numpy import save
from sklearn.preprocessing import StandardScaler, OneHotEncoder
from sklearn.compose import ColumnTransformer
from helpers import get_tidy_data_path
from dynamodb_helpers import get_tidy_data_path
df = pd.read_parquet(get_tidy_data_path() / 'current_race.parquet')
......
dynamodb/tidy_data.py 0 → 100644
+ 20
− 0
View file @ 168a1a5c
import json
from dynamodb_helpers import *
raw_data_path = get_raw_data_path()
raw_data_path.mkdir(parents=True, exist_ok=True)
tidy_data_path = get_tidy_data_path()
tidy_data_path.mkdir(parents=True, exist_ok=True)
with open(get_raw_data_path() / 'rawdata.json', 'r') as f:
movie_item = json.load(f)
if not isinstance(movie_item, list):
movie_item = [movie_item]
tidy_movies = tidy_movie_data(movie_item)
tidy_movies.to_parquet(tidy_data_path / 'current_race.parquet')
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment