Regenerate website
Project: http://git-wip-us.apache.org/repos/asf/beam-site/repo Commit: http://git-wip-us.apache.org/repos/asf/beam-site/commit/f011e303 Tree: http://git-wip-us.apache.org/repos/asf/beam-site/tree/f011e303 Diff: http://git-wip-us.apache.org/repos/asf/beam-site/diff/f011e303 Branch: refs/heads/asf-site Commit: f011e303c71c81675ec6d7e535cd815fb5c32074 Parents: 0dd610f Author: Ahmet Altay <al...@google.com> Authored: Mon Apr 3 15:52:46 2017 -0700 Committer: Ahmet Altay <al...@google.com> Committed: Mon Apr 3 15:52:46 2017 -0700 ---------------------------------------------------------------------- content/get-started/quickstart-py/index.html | 37 ++++++++++++++++++++++- 1 file changed, 36 insertions(+), 1 deletion(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/beam-site/blob/f011e303/content/get-started/quickstart-py/index.html ---------------------------------------------------------------------- diff --git a/content/get-started/quickstart-py/index.html b/content/get-started/quickstart-py/index.html index ce774cb..7c8f2d3 100644 --- a/content/get-started/quickstart-py/index.html +++ b/content/get-started/quickstart-py/index.html @@ -163,7 +163,10 @@ </li> <li><a href="#get-apache-beam" id="markdown-toc-get-apache-beam">Get Apache Beam</a> <ul> <li><a href="#create-and-activate-a-virtual-environment" id="markdown-toc-create-and-activate-a-virtual-environment">Create and activate a virtual environment</a></li> - <li><a href="#download-and-install" id="markdown-toc-download-and-install">Download and install</a></li> + <li><a href="#download-and-install" id="markdown-toc-download-and-install">Download and install</a> <ul> + <li><a href="#extra-requirements" id="markdown-toc-extra-requirements">Extra Requirements</a></li> + </ul> + </li> </ul> </li> <li><a href="#execute-a-pipeline-locally" id="markdown-toc-execute-a-pipeline-locally">Execute a pipeline locally</a></li> @@ -227,6 +230,38 @@ environmentâs directories.</p> </code></pre> </div> +<h4 id="extra-requirements">Extra Requirements</h4> + +<p>The above installation will not install all the extra dependencies for using features like the Google Cloud Dataflow runner. Information on what extra packages are required for different features are highlighted below. It is possible to install multitple extra requirements using something like <code class="highlighter-rouge">pip install apache-beam[feature1, feature2]</code>.</p> + +<ul> + <li><strong>Google Cloud Platform</strong> + <ul> + <li>Installation Command: <code class="highlighter-rouge">pip install apache-beam[gcp]</code></li> + <li>Required for: + <ul> + <li>Google Cloud Dataflow Runner</li> + <li>GCS IO</li> + <li>Datastore IO</li> + <li>BigQuery IO</li> + </ul> + </li> + </ul> + </li> + <li><strong>Tests</strong> + <ul> + <li>Installation Command: <code class="highlighter-rouge">pip install apache-beam[test]</code></li> + <li>Required for developing on beam and running unittests</li> + </ul> + </li> + <li><strong>Docs</strong> + <ul> + <li>Installation Command: <code class="highlighter-rouge">pip install apache-beam[docs]</code></li> + <li>Generating API documentation using Sphinx</li> + </ul> + </li> +</ul> + <h2 id="execute-a-pipeline-locally">Execute a pipeline locally</h2> <p>The Apache Beam <a href="https://github.com/apache/beam/tree/master/sdks/python/apache_beam/examples">examples</a> directory has many examples. All examples can be run locally by passing the required arguments described in the example script.</p>