TobKed commented on a change in pull request #12814: URL: https://github.com/apache/airflow/pull/12814#discussion_r568019985
########## File path: airflow/providers/apache/beam/README.md ########## @@ -0,0 +1,75 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. + --> + + +# Package apache-airflow-providers-apache-beam + +Release: 0.0.1 + +**Table of contents** + +- [Provider package](#provider-package) +- [Installation](#installation) +- [PIP requirements](#pip-requirements) +- [Cross provider package dependencies](#cross-provider-package-dependencies) +- [Provider class summary](#provider-classes-summary) + - [Operators](#operators) + - [Transfer operators](#transfer-operators) + - [Hooks](#hooks) +- [Releases](#releases) + + +## Provider package + +This is a provider package for `apache.beam` provider. All classes for this provider package +are in `airflow.providers.apache.beam` python package. + + +## Installation + +You can install this package on top of an existing airflow 2.* installation via +`pip install apache-airflow-providers-apache-beam` + + +## PIP requirements + + +## Cross provider package dependencies + +Those are dependencies that might be needed in order to use all the features of the package. +You need to install the specified backport providers package in order to use them. + + +# Provider classes summary + +In Airflow 2.0, all operators, transfers, hooks, sensors, secrets for the `apache.beam` provider +are in the `airflow.providers.apache.beam` package. You can read more about the naming conventions used +in [Naming conventions for provider packages](https://github.com/apache/airflow/blob/master/CONTRIBUTING.rst#naming-conventions-for-provider-packages) + + +## Operators + Review comment: Sure. I improved Readme ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: [email protected]
