diff --git a/.gitignore b/.gitignore
index 250c32e382d8658d68cb134371e02fba8306885e..5c0af16894b0847aafd35657b1fb89280ef6e418 100644
--- a/.gitignore
+++ b/.gitignore
@@ -62,6 +62,7 @@ instance/
# Sphinx documentation
docs/_build/
+docs/generated/
# PyBuilder
target/
@@ -94,6 +95,7 @@ ENV/
# My Data
/Data
+/Data/*
# Vs code Setting
.vscode/
@@ -103,3 +105,5 @@ ENV/
# Ignore config file with sensitive information
config.ini
+
+.DS_Store
\ No newline at end of file
diff --git a/docs/API.rst b/docs/API.rst
index 7e329883b1d51fc761818959a8a291c7298a489c..5d638264fd36fbd9029d577ad84963d1e01a1472 100644
--- a/docs/API.rst
+++ b/docs/API.rst
@@ -4,4 +4,4 @@ API
.. autosummary::
:toctree: generated
- formulaone.helpers
\ No newline at end of file
+ dynamodb.dynamodb_helpers
\ No newline at end of file
diff --git a/docs/docHTMLs/.buildinfo b/docs/docHTMLs/.buildinfo
new file mode 100644
index 0000000000000000000000000000000000000000..876e04787aeb018f1fb0d7a7c70c3abe8d3ce15d
--- /dev/null
+++ b/docs/docHTMLs/.buildinfo
@@ -0,0 +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: 192e42e872864313c12dcb7e3a4cfed8
+tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/docHTMLs/.doctrees/API.doctree b/docs/docHTMLs/.doctrees/API.doctree
new file mode 100644
index 0000000000000000000000000000000000000000..546978c04f55ecc26fb087e95874c78a93c876ba
Binary files /dev/null and b/docs/docHTMLs/.doctrees/API.doctree differ
diff --git a/docs/docHTMLs/.doctrees/dynamodb.doctree b/docs/docHTMLs/.doctrees/dynamodb.doctree
new file mode 100644
index 0000000000000000000000000000000000000000..7fa800294212a04688cf9897b1ebbeb489635d62
Binary files /dev/null and b/docs/docHTMLs/.doctrees/dynamodb.doctree differ
diff --git a/docs/docHTMLs/.doctrees/environment.pickle b/docs/docHTMLs/.doctrees/environment.pickle
new file mode 100644
index 0000000000000000000000000000000000000000..96ad11b212bba7eccd02323e3329dcffc5378a5e
Binary files /dev/null and b/docs/docHTMLs/.doctrees/environment.pickle differ
diff --git a/docs/docHTMLs/.doctrees/generated/dynamodb.dynamodb_helpers.doctree b/docs/docHTMLs/.doctrees/generated/dynamodb.dynamodb_helpers.doctree
new file mode 100644
index 0000000000000000000000000000000000000000..6ba927740e6c71bbafe675f0509981790e4f5833
Binary files /dev/null and b/docs/docHTMLs/.doctrees/generated/dynamodb.dynamodb_helpers.doctree differ
diff --git a/docs/docHTMLs/.doctrees/generated/ergast.doctree b/docs/docHTMLs/.doctrees/generated/ergast.doctree
new file mode 100644
index 0000000000000000000000000000000000000000..e67f2a97ae1a743dbe450d0b09c4e1b213252567
Binary files /dev/null and b/docs/docHTMLs/.doctrees/generated/ergast.doctree differ
diff --git a/docs/docHTMLs/.doctrees/generated/sample.doctree b/docs/docHTMLs/.doctrees/generated/sample.doctree
new file mode 100644
index 0000000000000000000000000000000000000000..863b88638ea0d6b6fbbf997584b29d06cbe2d31c
Binary files /dev/null and b/docs/docHTMLs/.doctrees/generated/sample.doctree differ
diff --git a/docs/docHTMLs/.doctrees/generated/sample.helpers.doctree b/docs/docHTMLs/.doctrees/generated/sample.helpers.doctree
new file mode 100644
index 0000000000000000000000000000000000000000..2aaba718360a31200d4e761c0c0fbd95cd33e95c
Binary files /dev/null and b/docs/docHTMLs/.doctrees/generated/sample.helpers.doctree differ
diff --git a/docs/docHTMLs/.doctrees/index.doctree b/docs/docHTMLs/.doctrees/index.doctree
new file mode 100644
index 0000000000000000000000000000000000000000..d454fcad5398e2075259ed36f20126d4b7b63fdf
Binary files /dev/null and b/docs/docHTMLs/.doctrees/index.doctree differ
diff --git a/docs/docHTMLs/.doctrees/modules.doctree b/docs/docHTMLs/.doctrees/modules.doctree
new file mode 100644
index 0000000000000000000000000000000000000000..5cd4dd34821f8fdb376eeee66353fcc2dc3a07f5
Binary files /dev/null and b/docs/docHTMLs/.doctrees/modules.doctree differ
diff --git a/docs/docHTMLs/.doctrees/usage.doctree b/docs/docHTMLs/.doctrees/usage.doctree
new file mode 100644
index 0000000000000000000000000000000000000000..86fc7e9ff99323f83860271ec5bd7a7085c08ab1
Binary files /dev/null and b/docs/docHTMLs/.doctrees/usage.doctree differ
diff --git a/docs/docHTMLs/API.html b/docs/docHTMLs/API.html
new file mode 100644
index 0000000000000000000000000000000000000000..2b82e3d30e28391c2418310b4b5ba3fd53babbba
--- /dev/null
+++ b/docs/docHTMLs/API.html
@@ -0,0 +1,119 @@
+<!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>API — 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.dynamodb_helpers" href="generated/dynamodb.dynamodb_helpers.html" />
+ <link rel="prev" title="Usage" href="usage.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="generated/dynamodb.dynamodb_helpers.html" title="dynamodb.dynamodb_helpers"
+ accesskey="N">next</a> |</li>
+ <li class="right" >
+ <a href="usage.html" title="Usage"
+ accesskey="P">previous</a> |</li>
+ <li class="nav-item nav-item-0"><a href="index.html">sample v0.0.1 documentation</a> »</li>
+ <li class="nav-item nav-item-this"><a href="">API</a></li>
+ </ul>
+ </div>
+
+ <div class="document">
+ <div class="documentwrapper">
+ <div class="bodywrapper">
+ <div class="body" role="main">
+
+ <section id="api">
+<h1>API<a class="headerlink" href="#api" title="Link to this heading">¶</a></h1>
+<table class="autosummary longtable docutils align-default">
+<tbody>
+<tr class="row-odd"><td><p><a class="reference internal" href="generated/dynamodb.dynamodb_helpers.html#module-dynamodb.dynamodb_helpers" title="dynamodb.dynamodb_helpers"><code class="xref py py-obj docutils literal notranslate"><span class="pre">dynamodb.dynamodb_helpers</span></code></a></p></td>
+<td><p></p></td>
+</tr>
+</tbody>
+</table>
+</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="usage.html"
+ title="previous chapter">Usage</a></p>
+ </div>
+ <div>
+ <h4>Next topic</h4>
+ <p class="topless"><a href="generated/dynamodb.dynamodb_helpers.html"
+ title="next chapter">dynamodb.dynamodb_helpers</a></p>
+ </div>
+ <div role="note" aria-label="source link">
+ <h3>This Page</h3>
+ <ul class="this-page-menu">
+ <li><a href="_sources/API.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="generated/dynamodb.dynamodb_helpers.html" title="dynamodb.dynamodb_helpers"
+ >next</a> |</li>
+ <li class="right" >
+ <a href="usage.html" title="Usage"
+ >previous</a> |</li>
+ <li class="nav-item nav-item-0"><a href="index.html">sample v0.0.1 documentation</a> »</li>
+ <li class="nav-item nav-item-this"><a href="">API</a></li>
+ </ul>
+ </div>
+ <div class="footer" role="contentinfo">
+ © 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
diff --git a/docs/docHTMLs/_sources/API.rst.txt b/docs/docHTMLs/_sources/API.rst.txt
new file mode 100644
index 0000000000000000000000000000000000000000..5d638264fd36fbd9029d577ad84963d1e01a1472
--- /dev/null
+++ b/docs/docHTMLs/_sources/API.rst.txt
@@ -0,0 +1,7 @@
+API
+===
+
+.. autosummary::
+ :toctree: generated
+
+ dynamodb.dynamodb_helpers
\ No newline at end of file
diff --git a/docs/docHTMLs/_sources/dynamodb.rst.txt b/docs/docHTMLs/_sources/dynamodb.rst.txt
new file mode 100644
index 0000000000000000000000000000000000000000..356bcf3a894902f03dd0f1a1c94d2f211c94e5bb
--- /dev/null
+++ b/docs/docHTMLs/_sources/dynamodb.rst.txt
@@ -0,0 +1,53 @@
+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:
diff --git a/docs/docHTMLs/_sources/generated/dynamodb.dynamodb_helpers.rst.txt b/docs/docHTMLs/_sources/generated/dynamodb.dynamodb_helpers.rst.txt
new file mode 100644
index 0000000000000000000000000000000000000000..592c1d465bad2609f67dc05b251e76d789c2d33f
--- /dev/null
+++ b/docs/docHTMLs/_sources/generated/dynamodb.dynamodb_helpers.rst.txt
@@ -0,0 +1,38 @@
+dynamodb.dynamodb\_helpers
+==========================
+
+.. automodule:: dynamodb.dynamodb_helpers
+
+
+
+
+
+
+
+ .. rubric:: Functions
+
+ .. autosummary::
+
+ get_config
+ get_dynamodb_resource
+ get_movie_item
+ get_movies_table
+ get_path_to_data
+ get_raw_data_path
+ get_tidy_data_path
+ list_dynamodb_tables
+ query_movies_by_year
+ tidy_movie_data
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/docHTMLs/_sources/generated/ergast.rst.txt b/docs/docHTMLs/_sources/generated/ergast.rst.txt
new file mode 100644
index 0000000000000000000000000000000000000000..c072d5365b70ff79e2b2fcce6dc5eaacc78297de
--- /dev/null
+++ b/docs/docHTMLs/_sources/generated/ergast.rst.txt
@@ -0,0 +1,22 @@
+.. _ergast:
+
+Ergast API Interface
+====================
+
+.. currentmodule::
+ fastf1.ergast
+
+Introduction
+------------
+
+This module can be used to interface with the Ergast F1 API
+(https://ergast.com/mrd/). All Ergast endpoints are supported.
+
+The :class:`Ergast` object provides access to all API Endpoints of the
+Ergast API.
+
+The terms of use of Ergast apply (https://ergast.com/mrd/terms/).
+Especially take care not to exceed the specified rate limits.
+FastF1 will handle caching and it will try to enforce rate limits where
+possible. Make sure to know what limits apply. For more information on how
+FastF1 handles caching and rate limiting see :ref:`requests-and-caching`.
diff --git a/docs/docHTMLs/_sources/generated/sample.helpers.rst.txt b/docs/docHTMLs/_sources/generated/sample.helpers.rst.txt
new file mode 100644
index 0000000000000000000000000000000000000000..c75d5e614a7ed7854e0f49551b7ebc7e824420d2
--- /dev/null
+++ b/docs/docHTMLs/_sources/generated/sample.helpers.rst.txt
@@ -0,0 +1,31 @@
+sample.helpers
+==============
+
+.. automodule:: sample.helpers
+
+
+
+
+
+
+
+ .. rubric:: Functions
+
+ .. autosummary::
+
+ get_path_to_data
+ get_raw_data_path
+ get_tidy_data_path
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/docHTMLs/_sources/generated/sample.rst.txt b/docs/docHTMLs/_sources/generated/sample.rst.txt
new file mode 100644
index 0000000000000000000000000000000000000000..12cd9db926808d4a390dd8c57f04ef9906128537
--- /dev/null
+++ b/docs/docHTMLs/_sources/generated/sample.rst.txt
@@ -0,0 +1,23 @@
+sample
+======
+
+.. automodule:: sample
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/docHTMLs/_sources/index.rst.txt b/docs/docHTMLs/_sources/index.rst.txt
new file mode 100644
index 0000000000000000000000000000000000000000..5b22772d3cda7b79f1a58d239cc4811f5629ba2b
--- /dev/null
+++ b/docs/docHTMLs/_sources/index.rst.txt
@@ -0,0 +1,14 @@
+.. sample documentation master file, created by
+ sphinx-quickstart on Mon Apr 16 21:22:43 2012.
+ You can adapt this file completely to your liking, but it should at least
+ contain the root `toctree` directive.
+
+Welcome to sample's documentation!
+==================================
+
+Contents:
+
+.. toctree::
+ modules
+ usage
+ API
diff --git a/docs/docHTMLs/_sources/modules.rst.txt b/docs/docHTMLs/_sources/modules.rst.txt
new file mode 100644
index 0000000000000000000000000000000000000000..09e5b157f36214d15d7af1a6120d708ea9754640
--- /dev/null
+++ b/docs/docHTMLs/_sources/modules.rst.txt
@@ -0,0 +1,7 @@
+formulaone
+==========
+
+.. toctree::
+ :maxdepth: 4
+
+ dynamodb
diff --git a/docs/docHTMLs/_sources/usage.rst.txt b/docs/docHTMLs/_sources/usage.rst.txt
new file mode 100644
index 0000000000000000000000000000000000000000..ee6f0a67bb7e0282d527dd74d4f74cab14a96ad2
--- /dev/null
+++ b/docs/docHTMLs/_sources/usage.rst.txt
@@ -0,0 +1,47 @@
+Usage
+=====
+
+Helpers
+-------
+
+You can use the ``dynamodb.dynamodb_helpers.get_path_to_data()`` function:
+
+.. autofunction:: dynamodb.dynamodb_helpers.get_path_to_data
+
+Raw data folder is returned by ``dynamodb.dynamodb_helpers.get_raw_data_path()`` function:
+
+.. autofunction:: dynamodb.dynamodb_helpers.get_raw_data_path
+
+You can also use the ``dynamodb.dynamodb_helpers.get_tidy_data_path()`` function:
+
+.. 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
diff --git a/docs/docHTMLs/_static/basic.css b/docs/docHTMLs/_static/basic.css
new file mode 100644
index 0000000000000000000000000000000000000000..f316efcb47bde67762d472130ad86676339ffa7e
--- /dev/null
+++ b/docs/docHTMLs/_static/basic.css
@@ -0,0 +1,925 @@
+/*
+ * basic.css
+ * ~~~~~~~~~
+ *
+ * Sphinx stylesheet -- basic theme.
+ *
+ * :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
+ * :license: BSD, see LICENSE for details.
+ *
+ */
+
+/* -- main layout ----------------------------------------------------------- */
+
+div.clearer {
+ clear: both;
+}
+
+div.section::after {
+ display: block;
+ content: '';
+ clear: left;
+}
+
+/* -- relbar ---------------------------------------------------------------- */
+
+div.related {
+ width: 100%;
+ font-size: 90%;
+}
+
+div.related h3 {
+ display: none;
+}
+
+div.related ul {
+ margin: 0;
+ padding: 0 0 0 10px;
+ list-style: none;
+}
+
+div.related li {
+ display: inline;
+}
+
+div.related li.right {
+ float: right;
+ margin-right: 5px;
+}
+
+/* -- sidebar --------------------------------------------------------------- */
+
+div.sphinxsidebarwrapper {
+ padding: 10px 5px 0 10px;
+}
+
+div.sphinxsidebar {
+ float: left;
+ width: 230px;
+ margin-left: -100%;
+ font-size: 90%;
+ word-wrap: break-word;
+ overflow-wrap : break-word;
+}
+
+div.sphinxsidebar ul {
+ list-style: none;
+}
+
+div.sphinxsidebar ul ul,
+div.sphinxsidebar ul.want-points {
+ margin-left: 20px;
+ list-style: square;
+}
+
+div.sphinxsidebar ul ul {
+ margin-top: 0;
+ margin-bottom: 0;
+}
+
+div.sphinxsidebar form {
+ margin-top: 10px;
+}
+
+div.sphinxsidebar input {
+ border: 1px solid #98dbcc;
+ font-family: sans-serif;
+ font-size: 1em;
+}
+
+div.sphinxsidebar #searchbox form.search {
+ overflow: hidden;
+}
+
+div.sphinxsidebar #searchbox input[type="text"] {
+ float: left;
+ width: 80%;
+ padding: 0.25em;
+ box-sizing: border-box;
+}
+
+div.sphinxsidebar #searchbox input[type="submit"] {
+ float: left;
+ width: 20%;
+ border-left: none;
+ padding: 0.25em;
+ box-sizing: border-box;
+}
+
+
+img {
+ border: 0;
+ max-width: 100%;
+}
+
+/* -- search page ----------------------------------------------------------- */
+
+ul.search {
+ margin: 10px 0 0 20px;
+ padding: 0;
+}
+
+ul.search li {
+ padding: 5px 0 5px 20px;
+ background-image: url(file.png);
+ background-repeat: no-repeat;
+ background-position: 0 7px;
+}
+
+ul.search li a {
+ font-weight: bold;
+}
+
+ul.search li p.context {
+ color: #888;
+ margin: 2px 0 0 30px;
+ text-align: left;
+}
+
+ul.keywordmatches li.goodmatch a {
+ font-weight: bold;
+}
+
+/* -- index page ------------------------------------------------------------ */
+
+table.contentstable {
+ width: 90%;
+ margin-left: auto;
+ margin-right: auto;
+}
+
+table.contentstable p.biglink {
+ line-height: 150%;
+}
+
+a.biglink {
+ font-size: 1.3em;
+}
+
+span.linkdescr {
+ font-style: italic;
+ padding-top: 5px;
+ font-size: 90%;
+}
+
+/* -- general index --------------------------------------------------------- */
+
+table.indextable {
+ width: 100%;
+}
+
+table.indextable td {
+ text-align: left;
+ vertical-align: top;
+}
+
+table.indextable ul {
+ margin-top: 0;
+ margin-bottom: 0;
+ list-style-type: none;
+}
+
+table.indextable > tbody > tr > td > ul {
+ padding-left: 0em;
+}
+
+table.indextable tr.pcap {
+ height: 10px;
+}
+
+table.indextable tr.cap {
+ margin-top: 10px;
+ background-color: #f2f2f2;
+}
+
+img.toggler {
+ margin-right: 3px;
+ margin-top: 3px;
+ cursor: pointer;
+}
+
+div.modindex-jumpbox {
+ border-top: 1px solid #ddd;
+ border-bottom: 1px solid #ddd;
+ margin: 1em 0 1em 0;
+ padding: 0.4em;
+}
+
+div.genindex-jumpbox {
+ border-top: 1px solid #ddd;
+ border-bottom: 1px solid #ddd;
+ margin: 1em 0 1em 0;
+ padding: 0.4em;
+}
+
+/* -- domain module index --------------------------------------------------- */
+
+table.modindextable td {
+ padding: 2px;
+ border-collapse: collapse;
+}
+
+/* -- general body styles --------------------------------------------------- */
+
+div.body {
+ min-width: 360px;
+ max-width: 800px;
+}
+
+div.body p, div.body dd, div.body li, div.body blockquote {
+ -moz-hyphens: auto;
+ -ms-hyphens: auto;
+ -webkit-hyphens: auto;
+ hyphens: auto;
+}
+
+a.headerlink {
+ visibility: hidden;
+}
+
+a:visited {
+ color: #551A8B;
+}
+
+h1:hover > a.headerlink,
+h2:hover > a.headerlink,
+h3:hover > a.headerlink,
+h4:hover > a.headerlink,
+h5:hover > a.headerlink,
+h6:hover > a.headerlink,
+dt:hover > a.headerlink,
+caption:hover > a.headerlink,
+p.caption:hover > a.headerlink,
+div.code-block-caption:hover > a.headerlink {
+ visibility: visible;
+}
+
+div.body p.caption {
+ text-align: inherit;
+}
+
+div.body td {
+ text-align: left;
+}
+
+.first {
+ margin-top: 0 !important;
+}
+
+p.rubric {
+ margin-top: 30px;
+ font-weight: bold;
+}
+
+img.align-left, figure.align-left, .figure.align-left, object.align-left {
+ clear: left;
+ float: left;
+ margin-right: 1em;
+}
+
+img.align-right, figure.align-right, .figure.align-right, object.align-right {
+ clear: right;
+ float: right;
+ margin-left: 1em;
+}
+
+img.align-center, figure.align-center, .figure.align-center, object.align-center {
+ display: block;
+ margin-left: auto;
+ margin-right: auto;
+}
+
+img.align-default, figure.align-default, .figure.align-default {
+ display: block;
+ margin-left: auto;
+ margin-right: auto;
+}
+
+.align-left {
+ text-align: left;
+}
+
+.align-center {
+ text-align: center;
+}
+
+.align-default {
+ text-align: center;
+}
+
+.align-right {
+ text-align: right;
+}
+
+/* -- sidebars -------------------------------------------------------------- */
+
+div.sidebar,
+aside.sidebar {
+ margin: 0 0 0.5em 1em;
+ border: 1px solid #ddb;
+ padding: 7px;
+ background-color: #ffe;
+ width: 40%;
+ float: right;
+ clear: right;
+ overflow-x: auto;
+}
+
+p.sidebar-title {
+ font-weight: bold;
+}
+
+nav.contents,
+aside.topic,
+div.admonition, div.topic, blockquote {
+ clear: left;
+}
+
+/* -- topics ---------------------------------------------------------------- */
+
+nav.contents,
+aside.topic,
+div.topic {
+ border: 1px solid #ccc;
+ padding: 7px;
+ margin: 10px 0 10px 0;
+}
+
+p.topic-title {
+ font-size: 1.1em;
+ font-weight: bold;
+ margin-top: 10px;
+}
+
+/* -- admonitions ----------------------------------------------------------- */
+
+div.admonition {
+ margin-top: 10px;
+ margin-bottom: 10px;
+ padding: 7px;
+}
+
+div.admonition dt {
+ font-weight: bold;
+}
+
+p.admonition-title {
+ margin: 0px 10px 5px 0px;
+ font-weight: bold;
+}
+
+div.body p.centered {
+ text-align: center;
+ margin-top: 25px;
+}
+
+/* -- content of sidebars/topics/admonitions -------------------------------- */
+
+div.sidebar > :last-child,
+aside.sidebar > :last-child,
+nav.contents > :last-child,
+aside.topic > :last-child,
+div.topic > :last-child,
+div.admonition > :last-child {
+ margin-bottom: 0;
+}
+
+div.sidebar::after,
+aside.sidebar::after,
+nav.contents::after,
+aside.topic::after,
+div.topic::after,
+div.admonition::after,
+blockquote::after {
+ display: block;
+ content: '';
+ clear: both;
+}
+
+/* -- tables ---------------------------------------------------------------- */
+
+table.docutils {
+ margin-top: 10px;
+ margin-bottom: 10px;
+ border: 0;
+ border-collapse: collapse;
+}
+
+table.align-center {
+ margin-left: auto;
+ margin-right: auto;
+}
+
+table.align-default {
+ margin-left: auto;
+ margin-right: auto;
+}
+
+table caption span.caption-number {
+ font-style: italic;
+}
+
+table caption span.caption-text {
+}
+
+table.docutils td, table.docutils th {
+ padding: 1px 8px 1px 5px;
+ border-top: 0;
+ border-left: 0;
+ border-right: 0;
+ border-bottom: 1px solid #aaa;
+}
+
+th {
+ text-align: left;
+ padding-right: 5px;
+}
+
+table.citation {
+ border-left: solid 1px gray;
+ margin-left: 1px;
+}
+
+table.citation td {
+ border-bottom: none;
+}
+
+th > :first-child,
+td > :first-child {
+ margin-top: 0px;
+}
+
+th > :last-child,
+td > :last-child {
+ margin-bottom: 0px;
+}
+
+/* -- figures --------------------------------------------------------------- */
+
+div.figure, figure {
+ margin: 0.5em;
+ padding: 0.5em;
+}
+
+div.figure p.caption, figcaption {
+ padding: 0.3em;
+}
+
+div.figure p.caption span.caption-number,
+figcaption span.caption-number {
+ font-style: italic;
+}
+
+div.figure p.caption span.caption-text,
+figcaption span.caption-text {
+}
+
+/* -- field list styles ----------------------------------------------------- */
+
+table.field-list td, table.field-list th {
+ border: 0 !important;
+}
+
+.field-list ul {
+ margin: 0;
+ padding-left: 1em;
+}
+
+.field-list p {
+ margin: 0;
+}
+
+.field-name {
+ -moz-hyphens: manual;
+ -ms-hyphens: manual;
+ -webkit-hyphens: manual;
+ hyphens: manual;
+}
+
+/* -- hlist styles ---------------------------------------------------------- */
+
+table.hlist {
+ margin: 1em 0;
+}
+
+table.hlist td {
+ vertical-align: top;
+}
+
+/* -- object description styles --------------------------------------------- */
+
+.sig {
+ font-family: 'Consolas', 'Menlo', 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', monospace;
+}
+
+.sig-name, code.descname {
+ background-color: transparent;
+ font-weight: bold;
+}
+
+.sig-name {
+ font-size: 1.1em;
+}
+
+code.descname {
+ font-size: 1.2em;
+}
+
+.sig-prename, code.descclassname {
+ background-color: transparent;
+}
+
+.optional {
+ font-size: 1.3em;
+}
+
+.sig-paren {
+ font-size: larger;
+}
+
+.sig-param.n {
+ font-style: italic;
+}
+
+/* C++ specific styling */
+
+.sig-inline.c-texpr,
+.sig-inline.cpp-texpr {
+ font-family: unset;
+}
+
+.sig.c .k, .sig.c .kt,
+.sig.cpp .k, .sig.cpp .kt {
+ color: #0033B3;
+}
+
+.sig.c .m,
+.sig.cpp .m {
+ color: #1750EB;
+}
+
+.sig.c .s, .sig.c .sc,
+.sig.cpp .s, .sig.cpp .sc {
+ color: #067D17;
+}
+
+
+/* -- other body styles ----------------------------------------------------- */
+
+ol.arabic {
+ list-style: decimal;
+}
+
+ol.loweralpha {
+ list-style: lower-alpha;
+}
+
+ol.upperalpha {
+ list-style: upper-alpha;
+}
+
+ol.lowerroman {
+ list-style: lower-roman;
+}
+
+ol.upperroman {
+ list-style: upper-roman;
+}
+
+:not(li) > ol > li:first-child > :first-child,
+:not(li) > ul > li:first-child > :first-child {
+ margin-top: 0px;
+}
+
+:not(li) > ol > li:last-child > :last-child,
+:not(li) > ul > li:last-child > :last-child {
+ margin-bottom: 0px;
+}
+
+ol.simple ol p,
+ol.simple ul p,
+ul.simple ol p,
+ul.simple ul p {
+ margin-top: 0;
+}
+
+ol.simple > li:not(:first-child) > p,
+ul.simple > li:not(:first-child) > p {
+ margin-top: 0;
+}
+
+ol.simple p,
+ul.simple p {
+ margin-bottom: 0;
+}
+
+aside.footnote > span,
+div.citation > span {
+ float: left;
+}
+aside.footnote > span:last-of-type,
+div.citation > span:last-of-type {
+ padding-right: 0.5em;
+}
+aside.footnote > p {
+ margin-left: 2em;
+}
+div.citation > p {
+ margin-left: 4em;
+}
+aside.footnote > p:last-of-type,
+div.citation > p:last-of-type {
+ margin-bottom: 0em;
+}
+aside.footnote > p:last-of-type:after,
+div.citation > p:last-of-type:after {
+ content: "";
+ clear: both;
+}
+
+dl.field-list {
+ display: grid;
+ grid-template-columns: fit-content(30%) auto;
+}
+
+dl.field-list > dt {
+ font-weight: bold;
+ word-break: break-word;
+ padding-left: 0.5em;
+ padding-right: 5px;
+}
+
+dl.field-list > dd {
+ padding-left: 0.5em;
+ margin-top: 0em;
+ margin-left: 0em;
+ margin-bottom: 0em;
+}
+
+dl {
+ margin-bottom: 15px;
+}
+
+dd > :first-child {
+ margin-top: 0px;
+}
+
+dd ul, dd table {
+ margin-bottom: 10px;
+}
+
+dd {
+ margin-top: 3px;
+ margin-bottom: 10px;
+ margin-left: 30px;
+}
+
+.sig dd {
+ margin-top: 0px;
+ margin-bottom: 0px;
+}
+
+.sig dl {
+ margin-top: 0px;
+ margin-bottom: 0px;
+}
+
+dl > dd:last-child,
+dl > dd:last-child > :last-child {
+ margin-bottom: 0;
+}
+
+dt:target, span.highlighted {
+ background-color: #fbe54e;
+}
+
+rect.highlighted {
+ fill: #fbe54e;
+}
+
+dl.glossary dt {
+ font-weight: bold;
+ font-size: 1.1em;
+}
+
+.versionmodified {
+ font-style: italic;
+}
+
+.system-message {
+ background-color: #fda;
+ padding: 5px;
+ border: 3px solid red;
+}
+
+.footnote:target {
+ background-color: #ffa;
+}
+
+.line-block {
+ display: block;
+ margin-top: 1em;
+ margin-bottom: 1em;
+}
+
+.line-block .line-block {
+ margin-top: 0;
+ margin-bottom: 0;
+ margin-left: 1.5em;
+}
+
+.guilabel, .menuselection {
+ font-family: sans-serif;
+}
+
+.accelerator {
+ text-decoration: underline;
+}
+
+.classifier {
+ font-style: oblique;
+}
+
+.classifier:before {
+ font-style: normal;
+ margin: 0 0.5em;
+ content: ":";
+ display: inline-block;
+}
+
+abbr, acronym {
+ border-bottom: dotted 1px;
+ cursor: help;
+}
+
+.translated {
+ background-color: rgba(207, 255, 207, 0.2)
+}
+
+.untranslated {
+ background-color: rgba(255, 207, 207, 0.2)
+}
+
+/* -- code displays --------------------------------------------------------- */
+
+pre {
+ overflow: auto;
+ overflow-y: hidden; /* fixes display issues on Chrome browsers */
+}
+
+pre, div[class*="highlight-"] {
+ clear: both;
+}
+
+span.pre {
+ -moz-hyphens: none;
+ -ms-hyphens: none;
+ -webkit-hyphens: none;
+ hyphens: none;
+ white-space: nowrap;
+}
+
+div[class*="highlight-"] {
+ margin: 1em 0;
+}
+
+td.linenos pre {
+ border: 0;
+ background-color: transparent;
+ color: #aaa;
+}
+
+table.highlighttable {
+ display: block;
+}
+
+table.highlighttable tbody {
+ display: block;
+}
+
+table.highlighttable tr {
+ display: flex;
+}
+
+table.highlighttable td {
+ margin: 0;
+ padding: 0;
+}
+
+table.highlighttable td.linenos {
+ padding-right: 0.5em;
+}
+
+table.highlighttable td.code {
+ flex: 1;
+ overflow: hidden;
+}
+
+.highlight .hll {
+ display: block;
+}
+
+div.highlight pre,
+table.highlighttable pre {
+ margin: 0;
+}
+
+div.code-block-caption + div {
+ margin-top: 0;
+}
+
+div.code-block-caption {
+ margin-top: 1em;
+ padding: 2px 5px;
+ font-size: small;
+}
+
+div.code-block-caption code {
+ background-color: transparent;
+}
+
+table.highlighttable td.linenos,
+span.linenos,
+div.highlight span.gp { /* gp: Generic.Prompt */
+ user-select: none;
+ -webkit-user-select: text; /* Safari fallback only */
+ -webkit-user-select: none; /* Chrome/Safari */
+ -moz-user-select: none; /* Firefox */
+ -ms-user-select: none; /* IE10+ */
+}
+
+div.code-block-caption span.caption-number {
+ padding: 0.1em 0.3em;
+ font-style: italic;
+}
+
+div.code-block-caption span.caption-text {
+}
+
+div.literal-block-wrapper {
+ margin: 1em 0;
+}
+
+code.xref, a code {
+ background-color: transparent;
+ font-weight: bold;
+}
+
+h1 code, h2 code, h3 code, h4 code, h5 code, h6 code {
+ background-color: transparent;
+}
+
+.viewcode-link {
+ float: right;
+}
+
+.viewcode-back {
+ float: right;
+ font-family: sans-serif;
+}
+
+div.viewcode-block:target {
+ margin: -1px -10px;
+ padding: 0 10px;
+}
+
+/* -- math display ---------------------------------------------------------- */
+
+img.math {
+ vertical-align: middle;
+}
+
+div.body div.math p {
+ text-align: center;
+}
+
+span.eqno {
+ float: right;
+}
+
+span.eqno a.headerlink {
+ position: absolute;
+ z-index: 1;
+}
+
+div.math:hover a.headerlink {
+ visibility: visible;
+}
+
+/* -- printout stylesheet --------------------------------------------------- */
+
+@media print {
+ div.document,
+ div.documentwrapper,
+ div.bodywrapper {
+ margin: 0 !important;
+ width: 100%;
+ }
+
+ div.sphinxsidebar,
+ div.related,
+ div.footer,
+ #top-link {
+ display: none;
+ }
+}
\ No newline at end of file
diff --git a/docs/docHTMLs/_static/classic.css b/docs/docHTMLs/_static/classic.css
new file mode 100644
index 0000000000000000000000000000000000000000..55301478fcfaaf021f81abba63db2f8df409eb50
--- /dev/null
+++ b/docs/docHTMLs/_static/classic.css
@@ -0,0 +1,269 @@
+/*
+ * classic.css_t
+ * ~~~~~~~~~~~~~
+ *
+ * Sphinx stylesheet -- classic theme.
+ *
+ * :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
+ * :license: BSD, see LICENSE for details.
+ *
+ */
+
+@import url("basic.css");
+
+/* -- page layout ----------------------------------------------------------- */
+
+html {
+ /* CSS hack for macOS's scrollbar (see #1125) */
+ background-color: #FFFFFF;
+}
+
+body {
+ font-family: sans-serif;
+ font-size: 100%;
+ background-color: #11303d;
+ color: #000;
+ margin: 0;
+ padding: 0;
+}
+
+div.document {
+ display: flex;
+ background-color: #1c4e63;
+}
+
+div.documentwrapper {
+ float: left;
+ width: 100%;
+}
+
+div.bodywrapper {
+ margin: 0 0 0 230px;
+}
+
+div.body {
+ background-color: #ffffff;
+ color: #000000;
+ padding: 0 20px 30px 20px;
+}
+
+div.footer {
+ color: #ffffff;
+ width: 100%;
+ padding: 9px 0 9px 0;
+ text-align: center;
+ font-size: 75%;
+}
+
+div.footer a {
+ color: #ffffff;
+ text-decoration: underline;
+}
+
+div.related {
+ background-color: #133f52;
+ line-height: 30px;
+ color: #ffffff;
+}
+
+div.related a {
+ color: #ffffff;
+}
+
+div.sphinxsidebar {
+}
+
+div.sphinxsidebar h3 {
+ font-family: 'Trebuchet MS', sans-serif;
+ color: #ffffff;
+ font-size: 1.4em;
+ font-weight: normal;
+ margin: 0;
+ padding: 0;
+}
+
+div.sphinxsidebar h3 a {
+ color: #ffffff;
+}
+
+div.sphinxsidebar h4 {
+ font-family: 'Trebuchet MS', sans-serif;
+ color: #ffffff;
+ font-size: 1.3em;
+ font-weight: normal;
+ margin: 5px 0 0 0;
+ padding: 0;
+}
+
+div.sphinxsidebar p {
+ color: #ffffff;
+}
+
+div.sphinxsidebar p.topless {
+ margin: 5px 10px 10px 10px;
+}
+
+div.sphinxsidebar ul {
+ margin: 10px;
+ padding: 0;
+ color: #ffffff;
+}
+
+div.sphinxsidebar a {
+ color: #98dbcc;
+}
+
+div.sphinxsidebar input {
+ border: 1px solid #98dbcc;
+ font-family: sans-serif;
+ font-size: 1em;
+}
+
+
+
+/* -- hyperlink styles ------------------------------------------------------ */
+
+a {
+ color: #355f7c;
+ text-decoration: none;
+}
+
+a:visited {
+ color: #551a8b;
+ text-decoration: none;
+}
+
+a:hover {
+ text-decoration: underline;
+}
+
+
+
+/* -- body styles ----------------------------------------------------------- */
+
+div.body h1,
+div.body h2,
+div.body h3,
+div.body h4,
+div.body h5,
+div.body h6 {
+ font-family: 'Trebuchet MS', sans-serif;
+ background-color: #f2f2f2;
+ font-weight: normal;
+ color: #20435c;
+ border-bottom: 1px solid #ccc;
+ margin: 20px -20px 10px -20px;
+ padding: 3px 0 3px 10px;
+}
+
+div.body h1 { margin-top: 0; font-size: 200%; }
+div.body h2 { font-size: 160%; }
+div.body h3 { font-size: 140%; }
+div.body h4 { font-size: 120%; }
+div.body h5 { font-size: 110%; }
+div.body h6 { font-size: 100%; }
+
+a.headerlink {
+ color: #c60f0f;
+ font-size: 0.8em;
+ padding: 0 4px 0 4px;
+ text-decoration: none;
+}
+
+a.headerlink:hover {
+ background-color: #c60f0f;
+ color: white;
+}
+
+div.body p, div.body dd, div.body li, div.body blockquote {
+ text-align: justify;
+ line-height: 130%;
+}
+
+div.admonition p.admonition-title + p {
+ display: inline;
+}
+
+div.admonition p {
+ margin-bottom: 5px;
+}
+
+div.admonition pre {
+ margin-bottom: 5px;
+}
+
+div.admonition ul, div.admonition ol {
+ margin-bottom: 5px;
+}
+
+div.note {
+ background-color: #eee;
+ border: 1px solid #ccc;
+}
+
+div.seealso {
+ background-color: #ffc;
+ border: 1px solid #ff6;
+}
+
+nav.contents,
+aside.topic,
+div.topic {
+ background-color: #eee;
+}
+
+div.warning {
+ background-color: #ffe4e4;
+ border: 1px solid #f66;
+}
+
+p.admonition-title {
+ display: inline;
+}
+
+p.admonition-title:after {
+ content: ":";
+}
+
+pre {
+ padding: 5px;
+ background-color: unset;
+ color: unset;
+ line-height: 120%;
+ border: 1px solid #ac9;
+ border-left: none;
+ border-right: none;
+}
+
+code {
+ background-color: #ecf0f3;
+ padding: 0 1px 0 1px;
+ font-size: 0.95em;
+}
+
+th, dl.field-list > dt {
+ background-color: #ede;
+}
+
+.warning code {
+ background: #efc2c2;
+}
+
+.note code {
+ background: #d6d6d6;
+}
+
+.viewcode-back {
+ font-family: sans-serif;
+}
+
+div.viewcode-block:target {
+ background-color: #f4debf;
+ border-top: 1px solid #ac9;
+ border-bottom: 1px solid #ac9;
+}
+
+div.code-block-caption {
+ color: #efefef;
+ background-color: #1c4e63;
+}
\ No newline at end of file
diff --git a/docs/docHTMLs/_static/default.css b/docs/docHTMLs/_static/default.css
new file mode 100644
index 0000000000000000000000000000000000000000..81b9363634e0fd7a2651282abc4408ffec371df0
--- /dev/null
+++ b/docs/docHTMLs/_static/default.css
@@ -0,0 +1 @@
+@import url("classic.css");
diff --git a/docs/docHTMLs/_static/doctools.js b/docs/docHTMLs/_static/doctools.js
new file mode 100644
index 0000000000000000000000000000000000000000..4d67807d17d27b16d4ac115dc383523157635f93
--- /dev/null
+++ b/docs/docHTMLs/_static/doctools.js
@@ -0,0 +1,156 @@
+/*
+ * doctools.js
+ * ~~~~~~~~~~~
+ *
+ * Base JavaScript utilities for all Sphinx HTML documentation.
+ *
+ * :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
+ * :license: BSD, see LICENSE for details.
+ *
+ */
+"use strict";
+
+const BLACKLISTED_KEY_CONTROL_ELEMENTS = new Set([
+ "TEXTAREA",
+ "INPUT",
+ "SELECT",
+ "BUTTON",
+]);
+
+const _ready = (callback) => {
+ if (document.readyState !== "loading") {
+ callback();
+ } else {
+ document.addEventListener("DOMContentLoaded", callback);
+ }
+};
+
+/**
+ * Small JavaScript module for the documentation.
+ */
+const Documentation = {
+ init: () => {
+ Documentation.initDomainIndexTable();
+ Documentation.initOnKeyListeners();
+ },
+
+ /**
+ * i18n support
+ */
+ TRANSLATIONS: {},
+ PLURAL_EXPR: (n) => (n === 1 ? 0 : 1),
+ LOCALE: "unknown",
+
+ // gettext and ngettext don't access this so that the functions
+ // can safely bound to a different name (_ = Documentation.gettext)
+ gettext: (string) => {
+ const translated = Documentation.TRANSLATIONS[string];
+ switch (typeof translated) {
+ case "undefined":
+ return string; // no translation
+ case "string":
+ return translated; // translation exists
+ default:
+ return translated[0]; // (singular, plural) translation tuple exists
+ }
+ },
+
+ ngettext: (singular, plural, n) => {
+ const translated = Documentation.TRANSLATIONS[singular];
+ if (typeof translated !== "undefined")
+ return translated[Documentation.PLURAL_EXPR(n)];
+ return n === 1 ? singular : plural;
+ },
+
+ addTranslations: (catalog) => {
+ Object.assign(Documentation.TRANSLATIONS, catalog.messages);
+ Documentation.PLURAL_EXPR = new Function(
+ "n",
+ `return (${catalog.plural_expr})`
+ );
+ Documentation.LOCALE = catalog.locale;
+ },
+
+ /**
+ * helper function to focus on search bar
+ */
+ focusSearchBar: () => {
+ document.querySelectorAll("input[name=q]")[0]?.focus();
+ },
+
+ /**
+ * Initialise the domain index toggle buttons
+ */
+ initDomainIndexTable: () => {
+ const toggler = (el) => {
+ const idNumber = el.id.substr(7);
+ const toggledRows = document.querySelectorAll(`tr.cg-${idNumber}`);
+ if (el.src.substr(-9) === "minus.png") {
+ el.src = `${el.src.substr(0, el.src.length - 9)}plus.png`;
+ toggledRows.forEach((el) => (el.style.display = "none"));
+ } else {
+ el.src = `${el.src.substr(0, el.src.length - 8)}minus.png`;
+ toggledRows.forEach((el) => (el.style.display = ""));
+ }
+ };
+
+ const togglerElements = document.querySelectorAll("img.toggler");
+ togglerElements.forEach((el) =>
+ el.addEventListener("click", (event) => toggler(event.currentTarget))
+ );
+ togglerElements.forEach((el) => (el.style.display = ""));
+ if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) togglerElements.forEach(toggler);
+ },
+
+ initOnKeyListeners: () => {
+ // only install a listener if it is really needed
+ if (
+ !DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS &&
+ !DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS
+ )
+ return;
+
+ document.addEventListener("keydown", (event) => {
+ // bail for input elements
+ if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) return;
+ // bail with special keys
+ if (event.altKey || event.ctrlKey || event.metaKey) return;
+
+ if (!event.shiftKey) {
+ switch (event.key) {
+ case "ArrowLeft":
+ if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) break;
+
+ const prevLink = document.querySelector('link[rel="prev"]');
+ if (prevLink && prevLink.href) {
+ window.location.href = prevLink.href;
+ event.preventDefault();
+ }
+ break;
+ case "ArrowRight":
+ if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) break;
+
+ const nextLink = document.querySelector('link[rel="next"]');
+ if (nextLink && nextLink.href) {
+ window.location.href = nextLink.href;
+ event.preventDefault();
+ }
+ break;
+ }
+ }
+
+ // some keyboard layouts may need Shift to get /
+ switch (event.key) {
+ case "/":
+ if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) break;
+ Documentation.focusSearchBar();
+ event.preventDefault();
+ }
+ });
+ },
+};
+
+// quick alias for translations
+const _ = Documentation.gettext;
+
+_ready(Documentation.init);
diff --git a/docs/docHTMLs/_static/documentation_options.js b/docs/docHTMLs/_static/documentation_options.js
new file mode 100644
index 0000000000000000000000000000000000000000..5c18e31a8d94768901a351055825015ce00ffdc4
--- /dev/null
+++ b/docs/docHTMLs/_static/documentation_options.js
@@ -0,0 +1,13 @@
+const DOCUMENTATION_OPTIONS = {
+ VERSION: 'v0.0.1',
+ LANGUAGE: 'en',
+ COLLAPSE_INDEX: false,
+ BUILDER: 'html',
+ FILE_SUFFIX: '.html',
+ LINK_SUFFIX: '.html',
+ HAS_SOURCE: true,
+ SOURCELINK_SUFFIX: '.txt',
+ NAVIGATION_WITH_KEYS: false,
+ SHOW_SEARCH_SUMMARY: true,
+ ENABLE_SEARCH_SHORTCUTS: true,
+};
\ No newline at end of file
diff --git a/docs/docHTMLs/_static/file.png b/docs/docHTMLs/_static/file.png
new file mode 100644
index 0000000000000000000000000000000000000000..a858a410e4faa62ce324d814e4b816fff83a6fb3
Binary files /dev/null and b/docs/docHTMLs/_static/file.png differ
diff --git a/docs/docHTMLs/_static/language_data.js b/docs/docHTMLs/_static/language_data.js
new file mode 100644
index 0000000000000000000000000000000000000000..367b8ed81b4e411bee6f81208dba76fbe37e0e15
--- /dev/null
+++ b/docs/docHTMLs/_static/language_data.js
@@ -0,0 +1,199 @@
+/*
+ * language_data.js
+ * ~~~~~~~~~~~~~~~~
+ *
+ * This script contains the language-specific data used by searchtools.js,
+ * namely the list of stopwords, stemmer, scorer and splitter.
+ *
+ * :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
+ * :license: BSD, see LICENSE for details.
+ *
+ */
+
+var stopwords = ["a", "and", "are", "as", "at", "be", "but", "by", "for", "if", "in", "into", "is", "it", "near", "no", "not", "of", "on", "or", "such", "that", "the", "their", "then", "there", "these", "they", "this", "to", "was", "will", "with"];
+
+
+/* Non-minified version is copied as a separate JS file, if available */
+
+/**
+ * Porter Stemmer
+ */
+var Stemmer = function() {
+
+ var step2list = {
+ ational: 'ate',
+ tional: 'tion',
+ enci: 'ence',
+ anci: 'ance',
+ izer: 'ize',
+ bli: 'ble',
+ alli: 'al',
+ entli: 'ent',
+ eli: 'e',
+ ousli: 'ous',
+ ization: 'ize',
+ ation: 'ate',
+ ator: 'ate',
+ alism: 'al',
+ iveness: 'ive',
+ fulness: 'ful',
+ ousness: 'ous',
+ aliti: 'al',
+ iviti: 'ive',
+ biliti: 'ble',
+ logi: 'log'
+ };
+
+ var step3list = {
+ icate: 'ic',
+ ative: '',
+ alize: 'al',
+ iciti: 'ic',
+ ical: 'ic',
+ ful: '',
+ ness: ''
+ };
+
+ var c = "[^aeiou]"; // consonant
+ var v = "[aeiouy]"; // vowel
+ var C = c + "[^aeiouy]*"; // consonant sequence
+ var V = v + "[aeiou]*"; // vowel sequence
+
+ var mgr0 = "^(" + C + ")?" + V + C; // [C]VC... is m>0
+ var meq1 = "^(" + C + ")?" + V + C + "(" + V + ")?$"; // [C]VC[V] is m=1
+ var mgr1 = "^(" + C + ")?" + V + C + V + C; // [C]VCVC... is m>1
+ var s_v = "^(" + C + ")?" + v; // vowel in stem
+
+ this.stemWord = function (w) {
+ var stem;
+ var suffix;
+ var firstch;
+ var origword = w;
+
+ if (w.length < 3)
+ return w;
+
+ var re;
+ var re2;
+ var re3;
+ var re4;
+
+ firstch = w.substr(0,1);
+ if (firstch == "y")
+ w = firstch.toUpperCase() + w.substr(1);
+
+ // Step 1a
+ re = /^(.+?)(ss|i)es$/;
+ re2 = /^(.+?)([^s])s$/;
+
+ if (re.test(w))
+ w = w.replace(re,"$1$2");
+ else if (re2.test(w))
+ w = w.replace(re2,"$1$2");
+
+ // Step 1b
+ re = /^(.+?)eed$/;
+ re2 = /^(.+?)(ed|ing)$/;
+ if (re.test(w)) {
+ var fp = re.exec(w);
+ re = new RegExp(mgr0);
+ if (re.test(fp[1])) {
+ re = /.$/;
+ w = w.replace(re,"");
+ }
+ }
+ else if (re2.test(w)) {
+ var fp = re2.exec(w);
+ stem = fp[1];
+ re2 = new RegExp(s_v);
+ if (re2.test(stem)) {
+ w = stem;
+ re2 = /(at|bl|iz)$/;
+ re3 = new RegExp("([^aeiouylsz])\\1$");
+ re4 = new RegExp("^" + C + v + "[^aeiouwxy]$");
+ if (re2.test(w))
+ w = w + "e";
+ else if (re3.test(w)) {
+ re = /.$/;
+ w = w.replace(re,"");
+ }
+ else if (re4.test(w))
+ w = w + "e";
+ }
+ }
+
+ // Step 1c
+ re = /^(.+?)y$/;
+ if (re.test(w)) {
+ var fp = re.exec(w);
+ stem = fp[1];
+ re = new RegExp(s_v);
+ if (re.test(stem))
+ w = stem + "i";
+ }
+
+ // Step 2
+ re = /^(.+?)(ational|tional|enci|anci|izer|bli|alli|entli|eli|ousli|ization|ation|ator|alism|iveness|fulness|ousness|aliti|iviti|biliti|logi)$/;
+ if (re.test(w)) {
+ var fp = re.exec(w);
+ stem = fp[1];
+ suffix = fp[2];
+ re = new RegExp(mgr0);
+ if (re.test(stem))
+ w = stem + step2list[suffix];
+ }
+
+ // Step 3
+ re = /^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/;
+ if (re.test(w)) {
+ var fp = re.exec(w);
+ stem = fp[1];
+ suffix = fp[2];
+ re = new RegExp(mgr0);
+ if (re.test(stem))
+ w = stem + step3list[suffix];
+ }
+
+ // Step 4
+ re = /^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/;
+ re2 = /^(.+?)(s|t)(ion)$/;
+ if (re.test(w)) {
+ var fp = re.exec(w);
+ stem = fp[1];
+ re = new RegExp(mgr1);
+ if (re.test(stem))
+ w = stem;
+ }
+ else if (re2.test(w)) {
+ var fp = re2.exec(w);
+ stem = fp[1] + fp[2];
+ re2 = new RegExp(mgr1);
+ if (re2.test(stem))
+ w = stem;
+ }
+
+ // Step 5
+ re = /^(.+?)e$/;
+ if (re.test(w)) {
+ var fp = re.exec(w);
+ stem = fp[1];
+ re = new RegExp(mgr1);
+ re2 = new RegExp(meq1);
+ re3 = new RegExp("^" + C + v + "[^aeiouwxy]$");
+ if (re.test(stem) || (re2.test(stem) && !(re3.test(stem))))
+ w = stem;
+ }
+ re = /ll$/;
+ re2 = new RegExp(mgr1);
+ if (re.test(w) && re2.test(w)) {
+ re = /.$/;
+ w = w.replace(re,"");
+ }
+
+ // and turn initial Y back to y
+ if (firstch == "y")
+ w = firstch.toLowerCase() + w.substr(1);
+ return w;
+ }
+}
+
diff --git a/docs/docHTMLs/_static/minus.png b/docs/docHTMLs/_static/minus.png
new file mode 100644
index 0000000000000000000000000000000000000000..d96755fdaf8bb2214971e0db9c1fd3077d7c419d
Binary files /dev/null and b/docs/docHTMLs/_static/minus.png differ
diff --git a/docs/docHTMLs/_static/plus.png b/docs/docHTMLs/_static/plus.png
new file mode 100644
index 0000000000000000000000000000000000000000..7107cec93a979b9a5f64843235a16651d563ce2d
Binary files /dev/null and b/docs/docHTMLs/_static/plus.png differ
diff --git a/docs/docHTMLs/_static/pygments.css b/docs/docHTMLs/_static/pygments.css
new file mode 100644
index 0000000000000000000000000000000000000000..0d49244edab19fa962288dd22673e9d57d60647e
--- /dev/null
+++ b/docs/docHTMLs/_static/pygments.css
@@ -0,0 +1,75 @@
+pre { line-height: 125%; }
+td.linenos .normal { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; }
+span.linenos { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; }
+td.linenos .special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
+span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
+.highlight .hll { background-color: #ffffcc }
+.highlight { background: #eeffcc; }
+.highlight .c { color: #408090; font-style: italic } /* Comment */
+.highlight .err { border: 1px solid #FF0000 } /* Error */
+.highlight .k { color: #007020; font-weight: bold } /* Keyword */
+.highlight .o { color: #666666 } /* Operator */
+.highlight .ch { color: #408090; font-style: italic } /* Comment.Hashbang */
+.highlight .cm { color: #408090; font-style: italic } /* Comment.Multiline */
+.highlight .cp { color: #007020 } /* Comment.Preproc */
+.highlight .cpf { color: #408090; font-style: italic } /* Comment.PreprocFile */
+.highlight .c1 { color: #408090; font-style: italic } /* Comment.Single */
+.highlight .cs { color: #408090; background-color: #fff0f0 } /* Comment.Special */
+.highlight .gd { color: #A00000 } /* Generic.Deleted */
+.highlight .ge { font-style: italic } /* Generic.Emph */
+.highlight .ges { font-weight: bold; font-style: italic } /* Generic.EmphStrong */
+.highlight .gr { color: #FF0000 } /* Generic.Error */
+.highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */
+.highlight .gi { color: #00A000 } /* Generic.Inserted */
+.highlight .go { color: #333333 } /* Generic.Output */
+.highlight .gp { color: #c65d09; font-weight: bold } /* Generic.Prompt */
+.highlight .gs { font-weight: bold } /* Generic.Strong */
+.highlight .gu { color: #800080; font-weight: bold } /* Generic.Subheading */
+.highlight .gt { color: #0044DD } /* Generic.Traceback */
+.highlight .kc { color: #007020; font-weight: bold } /* Keyword.Constant */
+.highlight .kd { color: #007020; font-weight: bold } /* Keyword.Declaration */
+.highlight .kn { color: #007020; font-weight: bold } /* Keyword.Namespace */
+.highlight .kp { color: #007020 } /* Keyword.Pseudo */
+.highlight .kr { color: #007020; font-weight: bold } /* Keyword.Reserved */
+.highlight .kt { color: #902000 } /* Keyword.Type */
+.highlight .m { color: #208050 } /* Literal.Number */
+.highlight .s { color: #4070a0 } /* Literal.String */
+.highlight .na { color: #4070a0 } /* Name.Attribute */
+.highlight .nb { color: #007020 } /* Name.Builtin */
+.highlight .nc { color: #0e84b5; font-weight: bold } /* Name.Class */
+.highlight .no { color: #60add5 } /* Name.Constant */
+.highlight .nd { color: #555555; font-weight: bold } /* Name.Decorator */
+.highlight .ni { color: #d55537; font-weight: bold } /* Name.Entity */
+.highlight .ne { color: #007020 } /* Name.Exception */
+.highlight .nf { color: #06287e } /* Name.Function */
+.highlight .nl { color: #002070; font-weight: bold } /* Name.Label */
+.highlight .nn { color: #0e84b5; font-weight: bold } /* Name.Namespace */
+.highlight .nt { color: #062873; font-weight: bold } /* Name.Tag */
+.highlight .nv { color: #bb60d5 } /* Name.Variable */
+.highlight .ow { color: #007020; font-weight: bold } /* Operator.Word */
+.highlight .w { color: #bbbbbb } /* Text.Whitespace */
+.highlight .mb { color: #208050 } /* Literal.Number.Bin */
+.highlight .mf { color: #208050 } /* Literal.Number.Float */
+.highlight .mh { color: #208050 } /* Literal.Number.Hex */
+.highlight .mi { color: #208050 } /* Literal.Number.Integer */
+.highlight .mo { color: #208050 } /* Literal.Number.Oct */
+.highlight .sa { color: #4070a0 } /* Literal.String.Affix */
+.highlight .sb { color: #4070a0 } /* Literal.String.Backtick */
+.highlight .sc { color: #4070a0 } /* Literal.String.Char */
+.highlight .dl { color: #4070a0 } /* Literal.String.Delimiter */
+.highlight .sd { color: #4070a0; font-style: italic } /* Literal.String.Doc */
+.highlight .s2 { color: #4070a0 } /* Literal.String.Double */
+.highlight .se { color: #4070a0; font-weight: bold } /* Literal.String.Escape */
+.highlight .sh { color: #4070a0 } /* Literal.String.Heredoc */
+.highlight .si { color: #70a0d0; font-style: italic } /* Literal.String.Interpol */
+.highlight .sx { color: #c65d09 } /* Literal.String.Other */
+.highlight .sr { color: #235388 } /* Literal.String.Regex */
+.highlight .s1 { color: #4070a0 } /* Literal.String.Single */
+.highlight .ss { color: #517918 } /* Literal.String.Symbol */
+.highlight .bp { color: #007020 } /* Name.Builtin.Pseudo */
+.highlight .fm { color: #06287e } /* Name.Function.Magic */
+.highlight .vc { color: #bb60d5 } /* Name.Variable.Class */
+.highlight .vg { color: #bb60d5 } /* Name.Variable.Global */
+.highlight .vi { color: #bb60d5 } /* Name.Variable.Instance */
+.highlight .vm { color: #bb60d5 } /* Name.Variable.Magic */
+.highlight .il { color: #208050 } /* Literal.Number.Integer.Long */
\ No newline at end of file
diff --git a/docs/docHTMLs/_static/searchtools.js b/docs/docHTMLs/_static/searchtools.js
new file mode 100644
index 0000000000000000000000000000000000000000..92da3f8b22cf5aab480b06cdb4e380a156152b5a
--- /dev/null
+++ b/docs/docHTMLs/_static/searchtools.js
@@ -0,0 +1,619 @@
+/*
+ * searchtools.js
+ * ~~~~~~~~~~~~~~~~
+ *
+ * Sphinx JavaScript utilities for the full-text search.
+ *
+ * :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
+ * :license: BSD, see LICENSE for details.
+ *
+ */
+"use strict";
+
+/**
+ * Simple result scoring code.
+ */
+if (typeof Scorer === "undefined") {
+ var Scorer = {
+ // Implement the following function to further tweak the score for each result
+ // The function takes a result array [docname, title, anchor, descr, score, filename]
+ // and returns the new score.
+ /*
+ score: result => {
+ const [docname, title, anchor, descr, score, filename] = result
+ return score
+ },
+ */
+
+ // query matches the full name of an object
+ objNameMatch: 11,
+ // or matches in the last dotted part of the object name
+ objPartialMatch: 6,
+ // Additive scores depending on the priority of the object
+ objPrio: {
+ 0: 15, // used to be importantResults
+ 1: 5, // used to be objectResults
+ 2: -5, // used to be unimportantResults
+ },
+ // Used when the priority is not in the mapping.
+ objPrioDefault: 0,
+
+ // query found in title
+ title: 15,
+ partialTitle: 7,
+ // query found in terms
+ term: 5,
+ partialTerm: 2,
+ };
+}
+
+const _removeChildren = (element) => {
+ while (element && element.lastChild) element.removeChild(element.lastChild);
+};
+
+/**
+ * See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions#escaping
+ */
+const _escapeRegExp = (string) =>
+ string.replace(/[.*+\-?^${}()|[\]\\]/g, "\\$&"); // $& means the whole matched string
+
+const _displayItem = (item, searchTerms, highlightTerms) => {
+ const docBuilder = DOCUMENTATION_OPTIONS.BUILDER;
+ const docFileSuffix = DOCUMENTATION_OPTIONS.FILE_SUFFIX;
+ const docLinkSuffix = DOCUMENTATION_OPTIONS.LINK_SUFFIX;
+ const showSearchSummary = DOCUMENTATION_OPTIONS.SHOW_SEARCH_SUMMARY;
+ const contentRoot = document.documentElement.dataset.content_root;
+
+ const [docName, title, anchor, descr, score, _filename] = item;
+
+ let listItem = document.createElement("li");
+ let requestUrl;
+ let linkUrl;
+ if (docBuilder === "dirhtml") {
+ // dirhtml builder
+ let dirname = docName + "/";
+ if (dirname.match(/\/index\/$/))
+ dirname = dirname.substring(0, dirname.length - 6);
+ else if (dirname === "index/") dirname = "";
+ requestUrl = contentRoot + dirname;
+ linkUrl = requestUrl;
+ } else {
+ // normal html builders
+ requestUrl = contentRoot + docName + docFileSuffix;
+ linkUrl = docName + docLinkSuffix;
+ }
+ let linkEl = listItem.appendChild(document.createElement("a"));
+ linkEl.href = linkUrl + anchor;
+ linkEl.dataset.score = score;
+ linkEl.innerHTML = title;
+ if (descr) {
+ listItem.appendChild(document.createElement("span")).innerHTML =
+ " (" + descr + ")";
+ // highlight search terms in the description
+ if (SPHINX_HIGHLIGHT_ENABLED) // set in sphinx_highlight.js
+ highlightTerms.forEach((term) => _highlightText(listItem, term, "highlighted"));
+ }
+ else if (showSearchSummary)
+ fetch(requestUrl)
+ .then((responseData) => responseData.text())
+ .then((data) => {
+ if (data)
+ listItem.appendChild(
+ Search.makeSearchSummary(data, searchTerms, anchor)
+ );
+ // highlight search terms in the summary
+ if (SPHINX_HIGHLIGHT_ENABLED) // set in sphinx_highlight.js
+ highlightTerms.forEach((term) => _highlightText(listItem, term, "highlighted"));
+ });
+ Search.output.appendChild(listItem);
+};
+const _finishSearch = (resultCount) => {
+ Search.stopPulse();
+ Search.title.innerText = _("Search Results");
+ if (!resultCount)
+ Search.status.innerText = Documentation.gettext(
+ "Your search did not match any documents. Please make sure that all words are spelled correctly and that you've selected enough categories."
+ );
+ else
+ Search.status.innerText = _(
+ "Search finished, found ${resultCount} page(s) matching the search query."
+ ).replace('${resultCount}', resultCount);
+};
+const _displayNextItem = (
+ results,
+ resultCount,
+ searchTerms,
+ highlightTerms,
+) => {
+ // results left, load the summary and display it
+ // this is intended to be dynamic (don't sub resultsCount)
+ if (results.length) {
+ _displayItem(results.pop(), searchTerms, highlightTerms);
+ setTimeout(
+ () => _displayNextItem(results, resultCount, searchTerms, highlightTerms),
+ 5
+ );
+ }
+ // search finished, update title and status message
+ else _finishSearch(resultCount);
+};
+// Helper function used by query() to order search results.
+// Each input is an array of [docname, title, anchor, descr, score, filename].
+// Order the results by score (in opposite order of appearance, since the
+// `_displayNextItem` function uses pop() to retrieve items) and then alphabetically.
+const _orderResultsByScoreThenName = (a, b) => {
+ const leftScore = a[4];
+ const rightScore = b[4];
+ if (leftScore === rightScore) {
+ // same score: sort alphabetically
+ const leftTitle = a[1].toLowerCase();
+ const rightTitle = b[1].toLowerCase();
+ if (leftTitle === rightTitle) return 0;
+ return leftTitle > rightTitle ? -1 : 1; // inverted is intentional
+ }
+ return leftScore > rightScore ? 1 : -1;
+};
+
+/**
+ * Default splitQuery function. Can be overridden in ``sphinx.search`` with a
+ * custom function per language.
+ *
+ * The regular expression works by splitting the string on consecutive characters
+ * that are not Unicode letters, numbers, underscores, or emoji characters.
+ * This is the same as ``\W+`` in Python, preserving the surrogate pair area.
+ */
+if (typeof splitQuery === "undefined") {
+ var splitQuery = (query) => query
+ .split(/[^\p{Letter}\p{Number}_\p{Emoji_Presentation}]+/gu)
+ .filter(term => term) // remove remaining empty strings
+}
+
+/**
+ * Search Module
+ */
+const Search = {
+ _index: null,
+ _queued_query: null,
+ _pulse_status: -1,
+
+ htmlToText: (htmlString, anchor) => {
+ const htmlElement = new DOMParser().parseFromString(htmlString, 'text/html');
+ for (const removalQuery of [".headerlinks", "script", "style"]) {
+ htmlElement.querySelectorAll(removalQuery).forEach((el) => { el.remove() });
+ }
+ if (anchor) {
+ const anchorContent = htmlElement.querySelector(`[role="main"] ${anchor}`);
+ if (anchorContent) return anchorContent.textContent;
+
+ console.warn(
+ `Anchored content block not found. Sphinx search tries to obtain it via DOM query '[role=main] ${anchor}'. Check your theme or template.`
+ );
+ }
+
+ // if anchor not specified or not found, fall back to main content
+ const docContent = htmlElement.querySelector('[role="main"]');
+ if (docContent) return docContent.textContent;
+
+ console.warn(
+ "Content block not found. Sphinx search tries to obtain it via DOM query '[role=main]'. Check your theme or template."
+ );
+ return "";
+ },
+
+ init: () => {
+ const query = new URLSearchParams(window.location.search).get("q");
+ document
+ .querySelectorAll('input[name="q"]')
+ .forEach((el) => (el.value = query));
+ if (query) Search.performSearch(query);
+ },
+
+ loadIndex: (url) =>
+ (document.body.appendChild(document.createElement("script")).src = url),
+
+ setIndex: (index) => {
+ Search._index = index;
+ if (Search._queued_query !== null) {
+ const query = Search._queued_query;
+ Search._queued_query = null;
+ Search.query(query);
+ }
+ },
+
+ hasIndex: () => Search._index !== null,
+
+ deferQuery: (query) => (Search._queued_query = query),
+
+ stopPulse: () => (Search._pulse_status = -1),
+
+ startPulse: () => {
+ if (Search._pulse_status >= 0) return;
+
+ const pulse = () => {
+ Search._pulse_status = (Search._pulse_status + 1) % 4;
+ Search.dots.innerText = ".".repeat(Search._pulse_status);
+ if (Search._pulse_status >= 0) window.setTimeout(pulse, 500);
+ };
+ pulse();
+ },
+
+ /**
+ * perform a search for something (or wait until index is loaded)
+ */
+ performSearch: (query) => {
+ // create the required interface elements
+ const searchText = document.createElement("h2");
+ searchText.textContent = _("Searching");
+ const searchSummary = document.createElement("p");
+ searchSummary.classList.add("search-summary");
+ searchSummary.innerText = "";
+ const searchList = document.createElement("ul");
+ searchList.classList.add("search");
+
+ const out = document.getElementById("search-results");
+ Search.title = out.appendChild(searchText);
+ Search.dots = Search.title.appendChild(document.createElement("span"));
+ Search.status = out.appendChild(searchSummary);
+ Search.output = out.appendChild(searchList);
+
+ const searchProgress = document.getElementById("search-progress");
+ // Some themes don't use the search progress node
+ if (searchProgress) {
+ searchProgress.innerText = _("Preparing search...");
+ }
+ Search.startPulse();
+
+ // index already loaded, the browser was quick!
+ if (Search.hasIndex()) Search.query(query);
+ else Search.deferQuery(query);
+ },
+
+ _parseQuery: (query) => {
+ // stem the search terms and add them to the correct list
+ const stemmer = new Stemmer();
+ const searchTerms = new Set();
+ const excludedTerms = new Set();
+ const highlightTerms = new Set();
+ const objectTerms = new Set(splitQuery(query.toLowerCase().trim()));
+ splitQuery(query.trim()).forEach((queryTerm) => {
+ const queryTermLower = queryTerm.toLowerCase();
+
+ // maybe skip this "word"
+ // stopwords array is from language_data.js
+ if (
+ stopwords.indexOf(queryTermLower) !== -1 ||
+ queryTerm.match(/^\d+$/)
+ )
+ return;
+
+ // stem the word
+ let word = stemmer.stemWord(queryTermLower);
+ // select the correct list
+ if (word[0] === "-") excludedTerms.add(word.substr(1));
+ else {
+ searchTerms.add(word);
+ highlightTerms.add(queryTermLower);
+ }
+ });
+
+ if (SPHINX_HIGHLIGHT_ENABLED) { // set in sphinx_highlight.js
+ localStorage.setItem("sphinx_highlight_terms", [...highlightTerms].join(" "))
+ }
+
+ // console.debug("SEARCH: searching for:");
+ // console.info("required: ", [...searchTerms]);
+ // console.info("excluded: ", [...excludedTerms]);
+
+ return [query, searchTerms, excludedTerms, highlightTerms, objectTerms];
+ },
+
+ /**
+ * execute search (requires search index to be loaded)
+ */
+ _performSearch: (query, searchTerms, excludedTerms, highlightTerms, objectTerms) => {
+ const filenames = Search._index.filenames;
+ const docNames = Search._index.docnames;
+ const titles = Search._index.titles;
+ const allTitles = Search._index.alltitles;
+ const indexEntries = Search._index.indexentries;
+
+ // Collect multiple result groups to be sorted separately and then ordered.
+ // Each is an array of [docname, title, anchor, descr, score, filename].
+ const normalResults = [];
+ const nonMainIndexResults = [];
+
+ _removeChildren(document.getElementById("search-progress"));
+
+ const queryLower = query.toLowerCase().trim();
+ for (const [title, foundTitles] of Object.entries(allTitles)) {
+ if (title.toLowerCase().trim().includes(queryLower) && (queryLower.length >= title.length/2)) {
+ for (const [file, id] of foundTitles) {
+ let score = Math.round(100 * queryLower.length / title.length)
+ normalResults.push([
+ docNames[file],
+ titles[file] !== title ? `${titles[file]} > ${title}` : title,
+ id !== null ? "#" + id : "",
+ null,
+ score,
+ filenames[file],
+ ]);
+ }
+ }
+ }
+
+ // search for explicit entries in index directives
+ for (const [entry, foundEntries] of Object.entries(indexEntries)) {
+ if (entry.includes(queryLower) && (queryLower.length >= entry.length/2)) {
+ for (const [file, id, isMain] of foundEntries) {
+ const score = Math.round(100 * queryLower.length / entry.length);
+ const result = [
+ docNames[file],
+ titles[file],
+ id ? "#" + id : "",
+ null,
+ score,
+ filenames[file],
+ ];
+ if (isMain) {
+ normalResults.push(result);
+ } else {
+ nonMainIndexResults.push(result);
+ }
+ }
+ }
+ }
+
+ // lookup as object
+ objectTerms.forEach((term) =>
+ normalResults.push(...Search.performObjectSearch(term, objectTerms))
+ );
+
+ // lookup as search terms in fulltext
+ normalResults.push(...Search.performTermsSearch(searchTerms, excludedTerms));
+
+ // let the scorer override scores with a custom scoring function
+ if (Scorer.score) {
+ normalResults.forEach((item) => (item[4] = Scorer.score(item)));
+ nonMainIndexResults.forEach((item) => (item[4] = Scorer.score(item)));
+ }
+
+ // Sort each group of results by score and then alphabetically by name.
+ normalResults.sort(_orderResultsByScoreThenName);
+ nonMainIndexResults.sort(_orderResultsByScoreThenName);
+
+ // Combine the result groups in (reverse) order.
+ // Non-main index entries are typically arbitrary cross-references,
+ // so display them after other results.
+ let results = [...nonMainIndexResults, ...normalResults];
+
+ // remove duplicate search results
+ // note the reversing of results, so that in the case of duplicates, the highest-scoring entry is kept
+ let seen = new Set();
+ results = results.reverse().reduce((acc, result) => {
+ let resultStr = result.slice(0, 4).concat([result[5]]).map(v => String(v)).join(',');
+ if (!seen.has(resultStr)) {
+ acc.push(result);
+ seen.add(resultStr);
+ }
+ return acc;
+ }, []);
+
+ return results.reverse();
+ },
+
+ query: (query) => {
+ const [searchQuery, searchTerms, excludedTerms, highlightTerms, objectTerms] = Search._parseQuery(query);
+ const results = Search._performSearch(searchQuery, searchTerms, excludedTerms, highlightTerms, objectTerms);
+
+ // for debugging
+ //Search.lastresults = results.slice(); // a copy
+ // console.info("search results:", Search.lastresults);
+
+ // print the results
+ _displayNextItem(results, results.length, searchTerms, highlightTerms);
+ },
+
+ /**
+ * search for object names
+ */
+ performObjectSearch: (object, objectTerms) => {
+ const filenames = Search._index.filenames;
+ const docNames = Search._index.docnames;
+ const objects = Search._index.objects;
+ const objNames = Search._index.objnames;
+ const titles = Search._index.titles;
+
+ const results = [];
+
+ const objectSearchCallback = (prefix, match) => {
+ const name = match[4]
+ const fullname = (prefix ? prefix + "." : "") + name;
+ const fullnameLower = fullname.toLowerCase();
+ if (fullnameLower.indexOf(object) < 0) return;
+
+ let score = 0;
+ const parts = fullnameLower.split(".");
+
+ // check for different match types: exact matches of full name or
+ // "last name" (i.e. last dotted part)
+ if (fullnameLower === object || parts.slice(-1)[0] === object)
+ score += Scorer.objNameMatch;
+ else if (parts.slice(-1)[0].indexOf(object) > -1)
+ score += Scorer.objPartialMatch; // matches in last name
+
+ const objName = objNames[match[1]][2];
+ const title = titles[match[0]];
+
+ // If more than one term searched for, we require other words to be
+ // found in the name/title/description
+ const otherTerms = new Set(objectTerms);
+ otherTerms.delete(object);
+ if (otherTerms.size > 0) {
+ const haystack = `${prefix} ${name} ${objName} ${title}`.toLowerCase();
+ if (
+ [...otherTerms].some((otherTerm) => haystack.indexOf(otherTerm) < 0)
+ )
+ return;
+ }
+
+ let anchor = match[3];
+ if (anchor === "") anchor = fullname;
+ else if (anchor === "-") anchor = objNames[match[1]][1] + "-" + fullname;
+
+ const descr = objName + _(", in ") + title;
+
+ // add custom score for some objects according to scorer
+ if (Scorer.objPrio.hasOwnProperty(match[2]))
+ score += Scorer.objPrio[match[2]];
+ else score += Scorer.objPrioDefault;
+
+ results.push([
+ docNames[match[0]],
+ fullname,
+ "#" + anchor,
+ descr,
+ score,
+ filenames[match[0]],
+ ]);
+ };
+ Object.keys(objects).forEach((prefix) =>
+ objects[prefix].forEach((array) =>
+ objectSearchCallback(prefix, array)
+ )
+ );
+ return results;
+ },
+
+ /**
+ * search for full-text terms in the index
+ */
+ performTermsSearch: (searchTerms, excludedTerms) => {
+ // prepare search
+ const terms = Search._index.terms;
+ const titleTerms = Search._index.titleterms;
+ const filenames = Search._index.filenames;
+ const docNames = Search._index.docnames;
+ const titles = Search._index.titles;
+
+ const scoreMap = new Map();
+ const fileMap = new Map();
+
+ // perform the search on the required terms
+ searchTerms.forEach((word) => {
+ const files = [];
+ const arr = [
+ { files: terms[word], score: Scorer.term },
+ { files: titleTerms[word], score: Scorer.title },
+ ];
+ // add support for partial matches
+ if (word.length > 2) {
+ const escapedWord = _escapeRegExp(word);
+ if (!terms.hasOwnProperty(word)) {
+ Object.keys(terms).forEach((term) => {
+ if (term.match(escapedWord))
+ arr.push({ files: terms[term], score: Scorer.partialTerm });
+ });
+ }
+ if (!titleTerms.hasOwnProperty(word)) {
+ Object.keys(titleTerms).forEach((term) => {
+ if (term.match(escapedWord))
+ arr.push({ files: titleTerms[term], score: Scorer.partialTitle });
+ });
+ }
+ }
+
+ // no match but word was a required one
+ if (arr.every((record) => record.files === undefined)) return;
+
+ // found search word in contents
+ arr.forEach((record) => {
+ if (record.files === undefined) return;
+
+ let recordFiles = record.files;
+ if (recordFiles.length === undefined) recordFiles = [recordFiles];
+ files.push(...recordFiles);
+
+ // set score for the word in each file
+ recordFiles.forEach((file) => {
+ if (!scoreMap.has(file)) scoreMap.set(file, {});
+ scoreMap.get(file)[word] = record.score;
+ });
+ });
+
+ // create the mapping
+ files.forEach((file) => {
+ if (!fileMap.has(file)) fileMap.set(file, [word]);
+ else if (fileMap.get(file).indexOf(word) === -1) fileMap.get(file).push(word);
+ });
+ });
+
+ // now check if the files don't contain excluded terms
+ const results = [];
+ for (const [file, wordList] of fileMap) {
+ // check if all requirements are matched
+
+ // as search terms with length < 3 are discarded
+ const filteredTermCount = [...searchTerms].filter(
+ (term) => term.length > 2
+ ).length;
+ if (
+ wordList.length !== searchTerms.size &&
+ wordList.length !== filteredTermCount
+ )
+ continue;
+
+ // ensure that none of the excluded terms is in the search result
+ if (
+ [...excludedTerms].some(
+ (term) =>
+ terms[term] === file ||
+ titleTerms[term] === file ||
+ (terms[term] || []).includes(file) ||
+ (titleTerms[term] || []).includes(file)
+ )
+ )
+ break;
+
+ // select one (max) score for the file.
+ const score = Math.max(...wordList.map((w) => scoreMap.get(file)[w]));
+ // add result to the result list
+ results.push([
+ docNames[file],
+ titles[file],
+ "",
+ null,
+ score,
+ filenames[file],
+ ]);
+ }
+ return results;
+ },
+
+ /**
+ * helper function to return a node containing the
+ * search summary for a given text. keywords is a list
+ * of stemmed words.
+ */
+ makeSearchSummary: (htmlText, keywords, anchor) => {
+ const text = Search.htmlToText(htmlText, anchor);
+ if (text === "") return null;
+
+ const textLower = text.toLowerCase();
+ const actualStartPosition = [...keywords]
+ .map((k) => textLower.indexOf(k.toLowerCase()))
+ .filter((i) => i > -1)
+ .slice(-1)[0];
+ const startWithContext = Math.max(actualStartPosition - 120, 0);
+
+ const top = startWithContext === 0 ? "" : "...";
+ const tail = startWithContext + 240 < text.length ? "..." : "";
+
+ let summary = document.createElement("p");
+ summary.classList.add("context");
+ summary.textContent = top + text.substr(startWithContext, 240).trim() + tail;
+
+ return summary;
+ },
+};
+
+_ready(Search.init);
diff --git a/docs/docHTMLs/_static/sidebar.js b/docs/docHTMLs/_static/sidebar.js
new file mode 100644
index 0000000000000000000000000000000000000000..f28c2068968c59a5f9c83661dadffd85d83c577a
--- /dev/null
+++ b/docs/docHTMLs/_static/sidebar.js
@@ -0,0 +1,70 @@
+/*
+ * sidebar.js
+ * ~~~~~~~~~~
+ *
+ * This script makes the Sphinx sidebar collapsible.
+ *
+ * .sphinxsidebar contains .sphinxsidebarwrapper. This script adds
+ * in .sphixsidebar, after .sphinxsidebarwrapper, the #sidebarbutton
+ * used to collapse and expand the sidebar.
+ *
+ * When the sidebar is collapsed the .sphinxsidebarwrapper is hidden
+ * and the width of the sidebar and the margin-left of the document
+ * are decreased. When the sidebar is expanded the opposite happens.
+ * This script saves a per-browser/per-session cookie used to
+ * remember the position of the sidebar among the pages.
+ * Once the browser is closed the cookie is deleted and the position
+ * reset to the default (expanded).
+ *
+ * :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
+ * :license: BSD, see LICENSE for details.
+ *
+ */
+
+const initialiseSidebar = () => {
+
+
+
+
+ // global elements used by the functions.
+ const bodyWrapper = document.getElementsByClassName("bodywrapper")[0]
+ const sidebar = document.getElementsByClassName("sphinxsidebar")[0]
+ const sidebarWrapper = document.getElementsByClassName('sphinxsidebarwrapper')[0]
+ const sidebarButton = document.getElementById("sidebarbutton")
+ const sidebarArrow = sidebarButton.querySelector('span')
+
+ // for some reason, the document has no sidebar; do not run into errors
+ if (typeof sidebar === "undefined") return;
+
+ const flipArrow = element => element.innerText = (element.innerText === "»") ? "«" : "»"
+
+ const collapse_sidebar = () => {
+ bodyWrapper.style.marginLeft = ".8em";
+ sidebar.style.width = ".8em"
+ sidebarWrapper.style.display = "none"
+ flipArrow(sidebarArrow)
+ sidebarButton.title = _('Expand sidebar')
+ window.localStorage.setItem("sidebar", "collapsed")
+ }
+
+ const expand_sidebar = () => {
+ bodyWrapper.style.marginLeft = ""
+ sidebar.style.removeProperty("width")
+ sidebarWrapper.style.display = ""
+ flipArrow(sidebarArrow)
+ sidebarButton.title = _('Collapse sidebar')
+ window.localStorage.setItem("sidebar", "expanded")
+ }
+
+ sidebarButton.addEventListener("click", () => {
+ (sidebarWrapper.style.display === "none") ? expand_sidebar() : collapse_sidebar()
+ })
+
+ if (!window.localStorage.getItem("sidebar")) return
+ const value = window.localStorage.getItem("sidebar")
+ if (value === "collapsed") collapse_sidebar();
+ else if (value === "expanded") expand_sidebar();
+}
+
+if (document.readyState !== "loading") initialiseSidebar()
+else document.addEventListener("DOMContentLoaded", initialiseSidebar)
\ No newline at end of file
diff --git a/docs/docHTMLs/_static/sphinx_highlight.js b/docs/docHTMLs/_static/sphinx_highlight.js
new file mode 100644
index 0000000000000000000000000000000000000000..8a96c69a1942318413af68fd459122b56edd8d69
--- /dev/null
+++ b/docs/docHTMLs/_static/sphinx_highlight.js
@@ -0,0 +1,154 @@
+/* Highlighting utilities for Sphinx HTML documentation. */
+"use strict";
+
+const SPHINX_HIGHLIGHT_ENABLED = true
+
+/**
+ * highlight a given string on a node by wrapping it in
+ * span elements with the given class name.
+ */
+const _highlight = (node, addItems, text, className) => {
+ if (node.nodeType === Node.TEXT_NODE) {
+ const val = node.nodeValue;
+ const parent = node.parentNode;
+ const pos = val.toLowerCase().indexOf(text);
+ if (
+ pos >= 0 &&
+ !parent.classList.contains(className) &&
+ !parent.classList.contains("nohighlight")
+ ) {
+ let span;
+
+ const closestNode = parent.closest("body, svg, foreignObject");
+ const isInSVG = closestNode && closestNode.matches("svg");
+ if (isInSVG) {
+ span = document.createElementNS("http://www.w3.org/2000/svg", "tspan");
+ } else {
+ span = document.createElement("span");
+ span.classList.add(className);
+ }
+
+ span.appendChild(document.createTextNode(val.substr(pos, text.length)));
+ const rest = document.createTextNode(val.substr(pos + text.length));
+ parent.insertBefore(
+ span,
+ parent.insertBefore(
+ rest,
+ node.nextSibling
+ )
+ );
+ node.nodeValue = val.substr(0, pos);
+ /* There may be more occurrences of search term in this node. So call this
+ * function recursively on the remaining fragment.
+ */
+ _highlight(rest, addItems, text, className);
+
+ if (isInSVG) {
+ const rect = document.createElementNS(
+ "http://www.w3.org/2000/svg",
+ "rect"
+ );
+ const bbox = parent.getBBox();
+ rect.x.baseVal.value = bbox.x;
+ rect.y.baseVal.value = bbox.y;
+ rect.width.baseVal.value = bbox.width;
+ rect.height.baseVal.value = bbox.height;
+ rect.setAttribute("class", className);
+ addItems.push({ parent: parent, target: rect });
+ }
+ }
+ } else if (node.matches && !node.matches("button, select, textarea")) {
+ node.childNodes.forEach((el) => _highlight(el, addItems, text, className));
+ }
+};
+const _highlightText = (thisNode, text, className) => {
+ let addItems = [];
+ _highlight(thisNode, addItems, text, className);
+ addItems.forEach((obj) =>
+ obj.parent.insertAdjacentElement("beforebegin", obj.target)
+ );
+};
+
+/**
+ * Small JavaScript module for the documentation.
+ */
+const SphinxHighlight = {
+
+ /**
+ * highlight the search words provided in localstorage in the text
+ */
+ highlightSearchWords: () => {
+ if (!SPHINX_HIGHLIGHT_ENABLED) return; // bail if no highlight
+
+ // get and clear terms from localstorage
+ const url = new URL(window.location);
+ const highlight =
+ localStorage.getItem("sphinx_highlight_terms")
+ || url.searchParams.get("highlight")
+ || "";
+ localStorage.removeItem("sphinx_highlight_terms")
+ url.searchParams.delete("highlight");
+ window.history.replaceState({}, "", url);
+
+ // get individual terms from highlight string
+ const terms = highlight.toLowerCase().split(/\s+/).filter(x => x);
+ if (terms.length === 0) return; // nothing to do
+
+ // There should never be more than one element matching "div.body"
+ const divBody = document.querySelectorAll("div.body");
+ const body = divBody.length ? divBody[0] : document.querySelector("body");
+ window.setTimeout(() => {
+ terms.forEach((term) => _highlightText(body, term, "highlighted"));
+ }, 10);
+
+ const searchBox = document.getElementById("searchbox");
+ if (searchBox === null) return;
+ searchBox.appendChild(
+ document
+ .createRange()
+ .createContextualFragment(
+ '<p class="highlight-link">' +
+ '<a href="javascript:SphinxHighlight.hideSearchWords()">' +
+ _("Hide Search Matches") +
+ "</a></p>"
+ )
+ );
+ },
+
+ /**
+ * helper function to hide the search marks again
+ */
+ hideSearchWords: () => {
+ document
+ .querySelectorAll("#searchbox .highlight-link")
+ .forEach((el) => el.remove());
+ document
+ .querySelectorAll("span.highlighted")
+ .forEach((el) => el.classList.remove("highlighted"));
+ localStorage.removeItem("sphinx_highlight_terms")
+ },
+
+ initEscapeListener: () => {
+ // only install a listener if it is really needed
+ if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) return;
+
+ document.addEventListener("keydown", (event) => {
+ // bail for input elements
+ if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) return;
+ // bail with special keys
+ if (event.shiftKey || event.altKey || event.ctrlKey || event.metaKey) return;
+ if (DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS && (event.key === "Escape")) {
+ SphinxHighlight.hideSearchWords();
+ event.preventDefault();
+ }
+ });
+ },
+};
+
+_ready(() => {
+ /* Do not call highlightSearchWords() when we are on the search page.
+ * It will highlight words from the *previous* search query.
+ */
+ if (typeof Search === "undefined") SphinxHighlight.highlightSearchWords();
+ SphinxHighlight.initEscapeListener();
+});
diff --git a/docs/docHTMLs/dynamodb.html b/docs/docHTMLs/dynamodb.html
new file mode 100644
index 0000000000000000000000000000000000000000..c27e9d27a60a07cf28b89a1c05be5c706954de81
--- /dev/null
+++ b/docs/docHTMLs/dynamodb.html
@@ -0,0 +1,297 @@
+<!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>dynamodb package — 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="Usage" href="usage.html" />
+ <link rel="prev" 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="usage.html" title="Usage"
+ accesskey="N">next</a> |</li>
+ <li class="right" >
+ <a href="modules.html" title="formulaone"
+ accesskey="P">previous</a> |</li>
+ <li class="nav-item nav-item-0"><a href="index.html">sample v0.0.1 documentation</a> »</li>
+ <li class="nav-item nav-item-1"><a href="modules.html" accesskey="U">formulaone</a> »</li>
+ <li class="nav-item nav-item-this"><a href="">dynamodb package</a></li>
+ </ul>
+ </div>
+
+ <div class="document">
+ <div class="documentwrapper">
+ <div class="bodywrapper">
+ <div class="body" role="main">
+
+ <section id="dynamodb-package">
+<h1>dynamodb package<a class="headerlink" href="#dynamodb-package" title="Link to this heading">¶</a></h1>
+<section id="submodules">
+<h2>Submodules<a class="headerlink" href="#submodules" title="Link to this heading">¶</a></h2>
+</section>
+<section id="module-dynamodb.core">
+<span id="dynamodb-core-module"></span><h2>dynamodb.core module<a class="headerlink" href="#module-dynamodb.core" title="Link to this heading">¶</a></h2>
+<dl class="py class">
+<dt class="sig sig-object py" id="dynamodb.core.DecimalEncoder">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">dynamodb.core.</span></span><span class="sig-name descname"><span class="pre">DecimalEncoder</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">skipkeys</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ensure_ascii</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">check_circular</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">allow_nan</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sort_keys</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">indent</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">separators</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">default</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#dynamodb.core.DecimalEncoder" title="Link to this definition">¶</a></dt>
+<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">JSONEncoder</span></code></p>
+<dl class="py method">
+<dt class="sig sig-object py" id="dynamodb.core.DecimalEncoder.default">
+<span class="sig-name descname"><span class="pre">default</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">obj</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#dynamodb.core.DecimalEncoder.default" title="Link to this definition">¶</a></dt>
+<dd><p>Implement this method in a subclass such that it returns
+a serializable object for <code class="docutils literal notranslate"><span class="pre">o</span></code>, or calls the base implementation
+(to raise a <code class="docutils literal notranslate"><span class="pre">TypeError</span></code>).</p>
+<p>For example, to support arbitrary iterators, you could
+implement default like this:</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">def</span> <span class="nf">default</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">o</span><span class="p">):</span>
+ <span class="k">try</span><span class="p">:</span>
+ <span class="n">iterable</span> <span class="o">=</span> <span class="nb">iter</span><span class="p">(</span><span class="n">o</span><span class="p">)</span>
+ <span class="k">except</span> <span class="ne">TypeError</span><span class="p">:</span>
+ <span class="k">pass</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="k">return</span> <span class="nb">list</span><span class="p">(</span><span class="n">iterable</span><span class="p">)</span>
+ <span class="c1"># Let the base class default method raise the TypeError</span>
+ <span class="k">return</span> <span class="n">JSONEncoder</span><span class="o">.</span><span class="n">default</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">o</span><span class="p">)</span>
+</pre></div>
+</div>
+</dd></dl>
+
+</dd></dl>
+
+</section>
+<section id="module-dynamodb.dynamodb_helpers">
+<span id="dynamodb-dynamodb-helpers-module"></span><h2>dynamodb.dynamodb_helpers module<a class="headerlink" href="#module-dynamodb.dynamodb_helpers" title="Link to this heading">¶</a></h2>
+<dl class="py function">
+<dt class="sig sig-object py" id="dynamodb.dynamodb_helpers.get_config">
+<span class="sig-prename descclassname"><span class="pre">dynamodb.dynamodb_helpers.</span></span><span class="sig-name descname"><span class="pre">get_config</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#dynamodb.dynamodb_helpers.get_config" title="Link to this definition">¶</a></dt>
+<dd><p>Reads the configuration file and returns the config object.</p>
+<dl class="simple">
+<dt>Returns:</dt><dd><p>config: The config object.</p>
+</dd>
+</dl>
+</dd></dl>
+
+<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>
+
+<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>
+
+<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>
+
+<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>
+
+<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>
+
+<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>
+
+<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>
+
+<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>
+
+<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 id="dynamodb-load-movies-module">
+<h2>dynamodb.load_movies module<a class="headerlink" href="#dynamodb-load-movies-module" title="Link to this heading">¶</a></h2>
+</section>
+<section id="dynamodb-prepare-data-module">
+<h2>dynamodb.prepare_data module<a class="headerlink" href="#dynamodb-prepare-data-module" title="Link to this heading">¶</a></h2>
+</section>
+<section id="dynamodb-tidy-data-module">
+<h2>dynamodb.tidy_data module<a class="headerlink" href="#dynamodb-tidy-data-module" title="Link to this heading">¶</a></h2>
+</section>
+<section id="module-dynamodb">
+<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-dynamodb" title="Link to this heading">¶</a></h2>
+</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="#">dynamodb package</a><ul>
+<li><a class="reference internal" href="#submodules">Submodules</a></li>
+<li><a class="reference internal" href="#module-dynamodb.core">dynamodb.core module</a><ul>
+<li><a class="reference internal" href="#dynamodb.core.DecimalEncoder"><code class="docutils literal notranslate"><span class="pre">DecimalEncoder</span></code></a><ul>
+<li><a class="reference internal" href="#dynamodb.core.DecimalEncoder.default"><code class="docutils literal notranslate"><span class="pre">DecimalEncoder.default()</span></code></a></li>
+</ul>
+</li>
+</ul>
+</li>
+<li><a class="reference internal" href="#module-dynamodb.dynamodb_helpers">dynamodb.dynamodb_helpers module</a><ul>
+<li><a class="reference internal" href="#dynamodb.dynamodb_helpers.get_config"><code class="docutils literal notranslate"><span class="pre">get_config()</span></code></a></li>
+<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.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.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_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>
+<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.query_movies_by_year"><code class="docutils literal notranslate"><span class="pre">query_movies_by_year()</span></code></a></li>
+<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>
+<li><a class="reference internal" href="#dynamodb-load-movies-module">dynamodb.load_movies module</a></li>
+<li><a class="reference internal" href="#dynamodb-prepare-data-module">dynamodb.prepare_data module</a></li>
+<li><a class="reference internal" href="#dynamodb-tidy-data-module">dynamodb.tidy_data module</a></li>
+<li><a class="reference internal" href="#module-dynamodb">Module contents</a></li>
+</ul>
+</li>
+</ul>
+
+ </div>
+ <div>
+ <h4>Previous topic</h4>
+ <p class="topless"><a href="modules.html"
+ title="previous chapter">formulaone</a></p>
+ </div>
+ <div>
+ <h4>Next topic</h4>
+ <p class="topless"><a href="usage.html"
+ title="next chapter">Usage</a></p>
+ </div>
+ <div role="note" aria-label="source link">
+ <h3>This Page</h3>
+ <ul class="this-page-menu">
+ <li><a href="_sources/dynamodb.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="usage.html" title="Usage"
+ >next</a> |</li>
+ <li class="right" >
+ <a href="modules.html" title="formulaone"
+ >previous</a> |</li>
+ <li class="nav-item nav-item-0"><a href="index.html">sample v0.0.1 documentation</a> »</li>
+ <li class="nav-item nav-item-1"><a href="modules.html" >formulaone</a> »</li>
+ <li class="nav-item nav-item-this"><a href="">dynamodb package</a></li>
+ </ul>
+ </div>
+ <div class="footer" role="contentinfo">
+ © 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
diff --git a/docs/docHTMLs/generated/dynamodb.dynamodb_helpers.html b/docs/docHTMLs/generated/dynamodb.dynamodb_helpers.html
new file mode 100644
index 0000000000000000000000000000000000000000..eba6919e88ae6bd8e07fc0a70478f3d1622b287a
--- /dev/null
+++ b/docs/docHTMLs/generated/dynamodb.dynamodb_helpers.html
@@ -0,0 +1,137 @@
+<!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>dynamodb.dynamodb_helpers — 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="prev" title="API" href="../API.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="P">previous</a> |</li>
+ <li class="nav-item nav-item-0"><a href="../index.html">sample v0.0.1 documentation</a> »</li>
+ <li class="nav-item nav-item-1"><a href="../API.html" accesskey="U">API</a> »</li>
+ <li class="nav-item nav-item-this"><a href="">dynamodb.dynamodb_helpers</a></li>
+ </ul>
+ </div>
+
+ <div class="document">
+ <div class="documentwrapper">
+ <div class="bodywrapper">
+ <div class="body" role="main">
+
+ <section id="module-dynamodb.dynamodb_helpers">
+<span id="dynamodb-dynamodb-helpers"></span><h1>dynamodb.dynamodb_helpers<a class="headerlink" href="#module-dynamodb.dynamodb_helpers" title="Link to this heading">¶</a></h1>
+<p class="rubric">Functions</p>
+<table class="autosummary longtable docutils align-default">
+<tbody>
+<tr class="row-odd"><td><p><a class="reference internal" href="../dynamodb.html#dynamodb.dynamodb_helpers.get_config" title="dynamodb.dynamodb_helpers.get_config"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_config</span></code></a>()</p></td>
+<td><p>Reads the configuration file and returns the config object.</p></td>
+</tr>
+<tr class="row-even"><td><p><a class="reference internal" href="../usage.html#dynamodb.dynamodb_helpers.get_dynamodb_resource" title="dynamodb.dynamodb_helpers.get_dynamodb_resource"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_dynamodb_resource</span></code></a>()</p></td>
+<td><p>Creates a DynamoDB resource using the AWS session.</p></td>
+</tr>
+<tr class="row-odd"><td><p><a class="reference internal" href="../usage.html#dynamodb.dynamodb_helpers.get_movie_item" title="dynamodb.dynamodb_helpers.get_movie_item"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_movie_item</span></code></a>(table, year, title)</p></td>
+<td><p>Gets a movie item from the DynamoDB table.</p></td>
+</tr>
+<tr class="row-even"><td><p><a class="reference internal" href="../usage.html#dynamodb.dynamodb_helpers.get_movies_table" title="dynamodb.dynamodb_helpers.get_movies_table"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_movies_table</span></code></a>(dynamo_resource)</p></td>
+<td><p>Gets the movies table from DynamoDB.</p></td>
+</tr>
+<tr class="row-odd"><td><p><a class="reference internal" href="../usage.html#dynamodb.dynamodb_helpers.get_path_to_data" title="dynamodb.dynamodb_helpers.get_path_to_data"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_path_to_data</span></code></a>()</p></td>
+<td><p>Return path to data.</p></td>
+</tr>
+<tr class="row-even"><td><p><a class="reference internal" href="../usage.html#dynamodb.dynamodb_helpers.get_raw_data_path" title="dynamodb.dynamodb_helpers.get_raw_data_path"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_raw_data_path</span></code></a>()</p></td>
+<td><p>Return path to raw data.</p></td>
+</tr>
+<tr class="row-odd"><td><p><a class="reference internal" href="../usage.html#dynamodb.dynamodb_helpers.get_tidy_data_path" title="dynamodb.dynamodb_helpers.get_tidy_data_path"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_tidy_data_path</span></code></a>()</p></td>
+<td><p>Return path to tidy data.</p></td>
+</tr>
+<tr class="row-even"><td><p><a class="reference internal" href="../usage.html#dynamodb.dynamodb_helpers.list_dynamodb_tables" title="dynamodb.dynamodb_helpers.list_dynamodb_tables"><code class="xref py py-obj docutils literal notranslate"><span class="pre">list_dynamodb_tables</span></code></a>(dynamo_resource)</p></td>
+<td><p>Lists all tables in the DynamoDB resource.</p></td>
+</tr>
+<tr class="row-odd"><td><p><a class="reference internal" href="../usage.html#dynamodb.dynamodb_helpers.query_movies_by_year" title="dynamodb.dynamodb_helpers.query_movies_by_year"><code class="xref py py-obj docutils literal notranslate"><span class="pre">query_movies_by_year</span></code></a>(table, year)</p></td>
+<td><p>Queries movies by year from the DynamoDB table.</p></td>
+</tr>
+<tr class="row-even"><td><p><a class="reference internal" href="../usage.html#dynamodb.dynamodb_helpers.tidy_movie_data" title="dynamodb.dynamodb_helpers.tidy_movie_data"><code class="xref py py-obj docutils literal notranslate"><span class="pre">tidy_movie_data</span></code></a>(movies)</p></td>
+<td><p>Transforms the raw movie data into a tidy DataFrame.</p></td>
+</tr>
+</tbody>
+</table>
+</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="../API.html"
+ title="previous 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/generated/dynamodb.dynamodb_helpers.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"
+ >previous</a> |</li>
+ <li class="nav-item nav-item-0"><a href="../index.html">sample v0.0.1 documentation</a> »</li>
+ <li class="nav-item nav-item-1"><a href="../API.html" >API</a> »</li>
+ <li class="nav-item nav-item-this"><a href="">dynamodb.dynamodb_helpers</a></li>
+ </ul>
+ </div>
+ <div class="footer" role="contentinfo">
+ © 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
diff --git a/docs/docHTMLs/generated/ergast.html b/docs/docHTMLs/generated/ergast.html
new file mode 100644
index 0000000000000000000000000000000000000000..0d2166e200b770bf13b3c029f1ce33efb4d2550c
--- /dev/null
+++ b/docs/docHTMLs/generated/ergast.html
@@ -0,0 +1,110 @@
+<!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>Ergast API Interface — 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> »</li>
+ <li class="nav-item nav-item-this"><a href="">Ergast API Interface</a></li>
+ </ul>
+ </div>
+
+ <div class="document">
+ <div class="documentwrapper">
+ <div class="bodywrapper">
+ <div class="body" role="main">
+
+ <section id="ergast-api-interface">
+<span id="ergast"></span><h1>Ergast API Interface<a class="headerlink" href="#ergast-api-interface" title="Link to this heading">¶</a></h1>
+<section id="introduction">
+<h2>Introduction<a class="headerlink" href="#introduction" title="Link to this heading">¶</a></h2>
+<p>This module can be used to interface with the Ergast F1 API
+(<a class="reference external" href="https://ergast.com/mrd/">https://ergast.com/mrd/</a>). All Ergast endpoints are supported.</p>
+<p>The <code class="xref py py-class docutils literal notranslate"><span class="pre">Ergast</span></code> object provides access to all API Endpoints of the
+Ergast API.</p>
+<p>The terms of use of Ergast apply (<a class="reference external" href="https://ergast.com/mrd/terms/">https://ergast.com/mrd/terms/</a>).
+Especially take care not to exceed the specified rate limits.
+FastF1 will handle caching and it will try to enforce rate limits where
+possible. Make sure to know what limits apply. For more information on how
+FastF1 handles caching and rate limiting see <span class="xref std std-ref">requests-and-caching</span>.</p>
+</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="#">Ergast API Interface</a><ul>
+<li><a class="reference internal" href="#introduction">Introduction</a></li>
+</ul>
+</li>
+</ul>
+
+ </div>
+ <div role="note" aria-label="source link">
+ <h3>This Page</h3>
+ <ul class="this-page-menu">
+ <li><a href="../_sources/generated/ergast.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> »</li>
+ <li class="nav-item nav-item-this"><a href="">Ergast API Interface</a></li>
+ </ul>
+ </div>
+ <div class="footer" role="contentinfo">
+ © 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
diff --git a/docs/docHTMLs/generated/sample.helpers.html b/docs/docHTMLs/generated/sample.helpers.html
new file mode 100644
index 0000000000000000000000000000000000000000..479bafe960f0ab04d9e0fdb5a2be0957b66c6cb7
--- /dev/null
+++ b/docs/docHTMLs/generated/sample.helpers.html
@@ -0,0 +1,88 @@
+<!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.helpers — 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> »</li>
+ <li class="nav-item nav-item-this"><a href="">sample.helpers</a></li>
+ </ul>
+ </div>
+
+ <div class="document">
+ <div class="documentwrapper">
+ <div class="bodywrapper">
+ <div class="body" role="main">
+
+ <section id="sample-helpers">
+<h1>sample.helpers<a class="headerlink" href="#sample-helpers" 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.helpers.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> »</li>
+ <li class="nav-item nav-item-this"><a href="">sample.helpers</a></li>
+ </ul>
+ </div>
+ <div class="footer" role="contentinfo">
+ © 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
diff --git a/docs/docHTMLs/generated/sample.html b/docs/docHTMLs/generated/sample.html
new file mode 100644
index 0000000000000000000000000000000000000000..024151f761cee56d0b4d46b5b215f5c6ff63a7ef
--- /dev/null
+++ b/docs/docHTMLs/generated/sample.html
@@ -0,0 +1,88 @@
+<!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 — 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> »</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> »</li>
+ <li class="nav-item nav-item-this"><a href="">sample</a></li>
+ </ul>
+ </div>
+ <div class="footer" role="contentinfo">
+ © 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
diff --git a/docs/docHTMLs/genindex.html b/docs/docHTMLs/genindex.html
new file mode 100644
index 0000000000000000000000000000000000000000..0b1c0d30ef6ca91f418705d74b8dec3f198751d4
--- /dev/null
+++ b/docs/docHTMLs/genindex.html
@@ -0,0 +1,185 @@
+<!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 — 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> »</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> »</li>
+ <li class="nav-item nav-item-this"><a href="">Index</a></li>
+ </ul>
+ </div>
+ <div class="footer" role="contentinfo">
+ © 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
diff --git a/docs/docHTMLs/index.html b/docs/docHTMLs/index.html
new file mode 100644
index 0000000000000000000000000000000000000000..f619320a15e1988c52500d7406ed86a4acc8e359
--- /dev/null
+++ b/docs/docHTMLs/index.html
@@ -0,0 +1,161 @@
+<!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! — 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> »</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> »</li>
+ <li class="nav-item nav-item-this"><a href="">Welcome to sample’s documentation!</a></li>
+ </ul>
+ </div>
+ <div class="footer" role="contentinfo">
+ © 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
diff --git a/docs/docHTMLs/modules.html b/docs/docHTMLs/modules.html
new file mode 100644
index 0000000000000000000000000000000000000000..37e3eb6e1db0fe62f953e175d0eb95221f553f4e
--- /dev/null
+++ b/docs/docHTMLs/modules.html
@@ -0,0 +1,144 @@
+<!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 — 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> »</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> »</li>
+ <li class="nav-item nav-item-this"><a href="">formulaone</a></li>
+ </ul>
+ </div>
+ <div class="footer" role="contentinfo">
+ © 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
diff --git a/docs/docHTMLs/objects.inv b/docs/docHTMLs/objects.inv
new file mode 100644
index 0000000000000000000000000000000000000000..1ecabc8abae5d21cf9756612ea7e6f8d9bb61fc8
--- /dev/null
+++ b/docs/docHTMLs/objects.inv
@@ -0,0 +1,8 @@
+# Sphinx inventory version 2
+# Project: sample
+# Version: v0.0.1
+# The remainder of this file is compressed using zlib.
+xڥ��n�0��|
+��Nrͭ@s�!��"�Q��墒�$��5�z}�J�lS^b�:���(%;�ʜ7�C�l�;.G�"��G��/��!��+R�?Q�ԣV�B���~p.s)��VQЀTY�9b��*T
:?�^�A���d��"K�LXS��P�h��ښ�� ��ѡ����k=�x)Lۗ��PϦ�� W��4@UF6�@0���50p�j��'��'�-쒿���E�m6<��]�
+��p~��Wܓ|�V��=�_�/)��'�z��z*CW���� G5���-z7� c�Pe]���ʹt��I7ۗw �H?'܃n�q9�����kv����iL
+Z&
�F���W֘��l6�I"~�V#';���x�ǵ
�p���~#��j���YO��E�:io4���:�*�Y:Sa���3-�� �41�bί�_�6�D*i7$�yX���䠂
\ No newline at end of file
diff --git a/docs/docHTMLs/py-modindex.html b/docs/docHTMLs/py-modindex.html
new file mode 100644
index 0000000000000000000000000000000000000000..7cf44669698ed64ee09060a391ea3726700fe20d
--- /dev/null
+++ b/docs/docHTMLs/py-modindex.html
@@ -0,0 +1,108 @@
+<!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 — 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> »</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> </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>   
+ <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>   
+ <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> »</li>
+ <li class="nav-item nav-item-this"><a href="">Python Module Index</a></li>
+ </ul>
+ </div>
+ <div class="footer" role="contentinfo">
+ © 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
diff --git a/docs/docHTMLs/search.html b/docs/docHTMLs/search.html
new file mode 100644
index 0000000000000000000000000000000000000000..b711ced1634294511c7b3c765ef4f99693ffec0b
--- /dev/null
+++ b/docs/docHTMLs/search.html
@@ -0,0 +1,100 @@
+<!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 — 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> »</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> »</li>
+ <li class="nav-item nav-item-this"><a href="">Search</a></li>
+ </ul>
+ </div>
+ <div class="footer" role="contentinfo">
+ © 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
diff --git a/docs/docHTMLs/searchindex.js b/docs/docHTMLs/searchindex.js
new file mode 100644
index 0000000000000000000000000000000000000000..140d5df4bafbb2c2ed66e52b731f72920a396d0f
--- /dev/null
+++ b/docs/docHTMLs/searchindex.js
@@ -0,0 +1 @@
+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
diff --git a/docs/docHTMLs/usage.html b/docs/docHTMLs/usage.html
new file mode 100644
index 0000000000000000000000000000000000000000..5e6bc0e9f59e083a67e152f2e0a657c6b0c5cfb8
--- /dev/null
+++ b/docs/docHTMLs/usage.html
@@ -0,0 +1,248 @@
+<!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 — 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> »</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> »</li>
+ <li class="nav-item nav-item-this"><a href="">Usage</a></li>
+ </ul>
+ </div>
+ <div class="footer" role="contentinfo">
+ © 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
diff --git a/docs/dynamodb.rst b/docs/dynamodb.rst
new file mode 100644
index 0000000000000000000000000000000000000000..356bcf3a894902f03dd0f1a1c94d2f211c94e5bb
--- /dev/null
+++ b/docs/dynamodb.rst
@@ -0,0 +1,53 @@
+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:
diff --git a/docs/formulaone.rst b/docs/formulaone.rst
deleted file mode 100644
index 35c40f68925a97792edf6b5070b77ac3d57874db..0000000000000000000000000000000000000000
--- a/docs/formulaone.rst
+++ /dev/null
@@ -1,61 +0,0 @@
-formulaone package
-==================
-
-Submodules
-----------
-
-formulaone.core module
-----------------------
-
-.. automodule:: formulaone.core
- :members:
- :undoc-members:
- :show-inheritance:
-
-formulaone.dynamodb\_helpers module
------------------------------------
-
-.. automodule:: formulaone.dynamodb_helpers
- :members:
- :undoc-members:
- :show-inheritance:
-
-formulaone.helpers module
--------------------------
-
-.. automodule:: formulaone.helpers
- :members:
- :undoc-members:
- :show-inheritance:
-
-formulaone.load\_latest\_race module
-------------------------------------
-
-.. automodule:: formulaone.load_latest_race
- :members:
- :undoc-members:
- :show-inheritance:
-
-formulaone.prepare\_data module
--------------------------------
-
-.. automodule:: formulaone.prepare_data
- :members:
- :undoc-members:
- :show-inheritance:
-
-formulaone.tidy\_data module
-----------------------------
-
-.. automodule:: formulaone.tidy_data
- :members:
- :undoc-members:
- :show-inheritance:
-
-Module contents
----------------
-
-.. automodule:: formulaone
- :members:
- :undoc-members:
- :show-inheritance:
diff --git a/docs/modules.rst b/docs/modules.rst
index b2a413d6ea51d0f722bbff4d7b5d8ad797ea8e56..09e5b157f36214d15d7af1a6120d708ea9754640 100644
--- a/docs/modules.rst
+++ b/docs/modules.rst
@@ -4,4 +4,4 @@ formulaone
.. toctree::
:maxdepth: 4
- formulaone
+ dynamodb
diff --git a/docs/usage.rst b/docs/usage.rst
index bd80d08f543d5f97fc5f1621085ff0fd23129a34..ee6f0a67bb7e0282d527dd74d4f74cab14a96ad2 100644
--- a/docs/usage.rst
+++ b/docs/usage.rst
@@ -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
diff --git a/dynamodb/Data/RawData/rawdata.json b/dynamodb/Data/RawData/rawdata.json
new file mode 100644
index 0000000000000000000000000000000000000000..5e122148dcde9fe33399f5f9330ede1471a0f3bb
--- /dev/null
+++ b/dynamodb/Data/RawData/rawdata.json
@@ -0,0 +1 @@
+{"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
diff --git a/dynamodb/Data/TidyData/current_race.parquet b/dynamodb/Data/TidyData/current_race.parquet
new file mode 100644
index 0000000000000000000000000000000000000000..1db8f03f3c65cc07c34c580879917c11998990b9
Binary files /dev/null and b/dynamodb/Data/TidyData/current_race.parquet differ
diff --git a/formulaone/__init__.py b/dynamodb/__init__.py
similarity index 100%
rename from formulaone/__init__.py
rename to dynamodb/__init__.py
diff --git a/dynamodb/core.py b/dynamodb/core.py
new file mode 100644
index 0000000000000000000000000000000000000000..05ba7a29bc42ed9becf1d81e23d1eeb2ee1b93d3
--- /dev/null
+++ b/dynamodb/core.py
@@ -0,0 +1,13 @@
+# -*- 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
diff --git a/formulaone/dynamodb_helpers.py b/dynamodb/dynamodb_helpers.py
similarity index 92%
rename from formulaone/dynamodb_helpers.py
rename to dynamodb/dynamodb_helpers.py
index dc18e094033f1331b8d42b548c8a09a6bd348262..6c803085af4225d4f813c08cb74e76a1db3733ee 100644
--- a/formulaone/dynamodb_helpers.py
+++ b/dynamodb/dynamodb_helpers.py
@@ -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.
diff --git a/dynamodb/load_movies.py b/dynamodb/load_movies.py
new file mode 100644
index 0000000000000000000000000000000000000000..77071f0516637ad7350a40dc94be4e824f4528bf
--- /dev/null
+++ b/dynamodb/load_movies.py
@@ -0,0 +1,21 @@
+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
diff --git a/formulaone/prepare_data.py b/dynamodb/prepare_data.py
similarity index 94%
rename from formulaone/prepare_data.py
rename to dynamodb/prepare_data.py
index 61ddfb2b42935dd0d1ba3cc2d6d8404310ae7dc4..951dbf2863d37fbdc43fc2821341246fa9f4864a 100644
--- a/formulaone/prepare_data.py
+++ b/dynamodb/prepare_data.py
@@ -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')
diff --git a/dynamodb/tidy_data.py b/dynamodb/tidy_data.py
new file mode 100644
index 0000000000000000000000000000000000000000..3032d2ba14d6c564653fa013e100a62ef7909913
--- /dev/null
+++ b/dynamodb/tidy_data.py
@@ -0,0 +1,20 @@
+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')
diff --git a/formulaone/core.py b/formulaone/core.py
deleted file mode 100644
index d76c319cd908f08e693710c5cb02793253a5ec42..0000000000000000000000000000000000000000
--- a/formulaone/core.py
+++ /dev/null
@@ -1,6 +0,0 @@
-# -*- coding: utf-8 -*-
-
-
-def get_hmm():
- """Get a thought."""
- return 'hmmm...'
diff --git a/formulaone/helpers.py b/formulaone/helpers.py
deleted file mode 100644
index a172cd48e72791e321a5afc7b6d3ec1f8b3c4329..0000000000000000000000000000000000000000
--- a/formulaone/helpers.py
+++ /dev/null
@@ -1,16 +0,0 @@
-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'
diff --git a/formulaone/load_latest_race.py b/formulaone/load_latest_race.py
deleted file mode 100644
index eddffc4edd839bd1f78ccb67d25b44573876fcca..0000000000000000000000000000000000000000
--- a/formulaone/load_latest_race.py
+++ /dev/null
@@ -1,20 +0,0 @@
-import json
-import requests
-
-from helpers import get_raw_data_path
-
-base_url = 'http://ergast.com/api/f1/'
-endpoint = 'current/last/results.json'
-
-
-response = requests.get(
- url=base_url + endpoint
-)
-
-data = response.json()
-
-raw_data_path = get_raw_data_path()
-raw_data_path.mkdir(parents=True, exist_ok=True)
-
-with open(raw_data_path / 'current.json', 'w') as f:
- json.dump(data, f)
diff --git a/formulaone/tidy_data.py b/formulaone/tidy_data.py
deleted file mode 100644
index 29caf33e9308dd6cdb72f5998602e655ad49653e..0000000000000000000000000000000000000000
--- a/formulaone/tidy_data.py
+++ /dev/null
@@ -1,14 +0,0 @@
-import json
-import pandas as pd
-
-from helpers import get_raw_data_path, get_tidy_data_path
-
-tidy_data_path = get_tidy_data_path()
-tidy_data_path.mkdir(parents=True, exist_ok=True)
-
-with open(get_raw_data_path() / 'current.json', 'r') as f:
- d = json.load(f)
-
-df = pd.json_normalize(d['MRData']['RaceTable']['Races'][0]['Results'])
-
-df.to_parquet(tidy_data_path / 'current_race.parquet')
diff --git a/setup.py b/setup.py
index 8afcb488ae506f61cf649c8930b121888e12b121..b9a2afe11c764d05006b26424b7b015e2d9df5c3 100755
--- a/setup.py
+++ b/setup.py
@@ -1,7 +1,5 @@
# -*- coding: utf-8 -*-
-# Learn more: https://github.com/kennethreitz/setup.py
-
from setuptools import setup, find_packages
@@ -12,13 +10,13 @@ with open('LICENSE') as f:
license = f.read()
setup(
- name='formulaone',
- version='0.1.1', # increase version by 0.0.1
- description='Downloads and prepares formula one data',
+ name='dynamodb',
+ version='0.1.2', # increase version by 0.0.1
+ description='Downloads and prepares db movie data',
long_description=readme,
- author='Timo Schuerg',
- author_email='t.schuerg@th-bingen.de',
- url='https://github.com/kennethreitz/samplemod',
+ author='Safouan Er-Ryfy',
+ author_email='safouan.erryfy@stud.h-da.de',
+ url='https://code.fbi.h-da.de/safouan.erryfy/dynamodb',
license=license,
packages=find_packages(exclude=('tests', 'docs'))
)
diff --git a/tests/test_basic.py b/tests/test_basic.py
index c28980fc60292e881cacc0df1e5fb53310a710d3..013452b1a30f850a26e9ef7e4a37cc8dda3882da 100644
--- a/tests/test_basic.py
+++ b/tests/test_basic.py
@@ -6,7 +6,7 @@ import sys
sys.path.insert(0, os.path.abspath(os.path.join(os.path.dirname(__file__), '..')))
#from formulaone.sample.helpers import get_tidy_data_path
-from formulaone.helpers import get_tidy_data_path
+from dynamodb.helpers import get_tidy_data_path
import pandas as pd
diff --git a/tests/test_dynamodb.py b/tests/test_dynamodb.py
index 8d47739334903808e64d7bd140d88c6f0098cda4..883d1f1f63680a35909064d82e5bb6ebf93c6a0d 100644
--- a/tests/test_dynamodb.py
+++ b/tests/test_dynamodb.py
@@ -12,7 +12,7 @@ module_path = os.path.abspath(os.path.join(os.getcwd(), 'formulaone'))
sys.path.insert(0, module_path)
print(sys.path.insert(0, module_path))
-from formulaone.dynamodb_helpers import *
+from dynamodb.dynamodb_helpers import *
def test_aws_config_keys():
"""Test the necessary AWS config keys."""