Repository: beam-site Updated Branches: refs/heads/asf-site 85103fb5f -> 5359c3294
[BEAM-1711] Add information about extra requires in Python Quickstart Project: http://git-wip-us.apache.org/repos/asf/beam-site/repo Commit: http://git-wip-us.apache.org/repos/asf/beam-site/commit/0dd610f7 Tree: http://git-wip-us.apache.org/repos/asf/beam-site/tree/0dd610f7 Diff: http://git-wip-us.apache.org/repos/asf/beam-site/diff/0dd610f7 Branch: refs/heads/asf-site Commit: 0dd610f73b6b6b673c3dec1b0633c2cf63ec5a60 Parents: 85103fb Author: Sourabh Bajaj <[email protected]> Authored: Mon Apr 3 13:40:04 2017 -0700 Committer: Sourabh Bajaj <[email protected]> Committed: Mon Apr 3 15:23:37 2017 -0700 ---------------------------------------------------------------------- src/get-started/quickstart-py.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/beam-site/blob/0dd610f7/src/get-started/quickstart-py.md ---------------------------------------------------------------------- diff --git a/src/get-started/quickstart-py.md b/src/get-started/quickstart-py.md index 6d729bd..efaa9dc 100644 --- a/src/get-started/quickstart-py.md +++ b/src/get-started/quickstart-py.md @@ -68,6 +68,24 @@ Install the latest Python SDK from PyPI: pip install apache-beam ``` +#### Extra Requirements + +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 `pip install apache-beam[feature1, feature2]`. + +- **Google Cloud Platform** + - Installation Command: `pip install apache-beam[gcp]` + - Required for: + - Google Cloud Dataflow Runner + - GCS IO + - Datastore IO + - BigQuery IO +- **Tests** + - Installation Command: `pip install apache-beam[test]` + - Required for developing on beam and running unittests +- **Docs** + - Installation Command: `pip install apache-beam[docs]` + - Generating API documentation using Sphinx + ## Execute a pipeline locally The Apache Beam [examples](https://github.com/apache/beam/tree/master/sdks/python/apache_beam/examples) directory has many examples. All examples can be run locally by passing the required arguments described in the example script.
