Skip to content
Snippets Groups Projects
dynamodb.dynamodb_helpers.html 7.9 KiB
Newer Older
  • Learn to ignore specific revisions
  • <!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 &#8212; sample v0.0.1 documentation</title>
        <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=fa44fd50" />
        <link rel="stylesheet" type="text/css" href="../_static/classic.css?v=def86cc0" />
        
        <script src="../_static/documentation_options.js?v=2fea6348"></script>
        <script src="../_static/doctools.js?v=9a2dae69"></script>
        <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
        
        <link rel="index" title="Index" href="../genindex.html" />
        <link rel="search" title="Search" href="../search.html" />
        <link rel="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> &#187;</li>
              <li class="nav-item nav-item-1"><a href="../API.html" accesskey="U">API</a> &#187;</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> &#187;</li>
              <li class="nav-item nav-item-1"><a href="../API.html" >API</a> &#187;</li>
            <li class="nav-item nav-item-this"><a href="">dynamodb.dynamodb_helpers</a></li> 
          </ul>
        </div>
        <div class="footer" role="contentinfo">
        &#169; Copyright 2012, Kenneth Reitz.
          Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.3.7.
        </div>
      </body>
    </html>