dev/provider_packages/PROVIDER_README_TEMPLATE.rst.jinja2

{#
 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.

 NOTE! THIS FILE IS AUTOMATICALLY GENERATED AND WILL BE
 OVERWRITTEN WHEN PREPARING PACKAGES.

 IF YOU WANT TO MODIFY IT, YOU SHOULD MODIFY THE TEMPLATE
 `PROVIDER_INDEX_TEMPLATE.rst.jinja2` IN the `dev/provider_packages` DIRECTORY

#}

Package ``{{ PACKAGE_PIP_NAME }}``

Release: ``{{ RELEASE }}{{ VERSION_SUFFIX }}``


{{  PROVIDER_DESCRIPTION | safe }}

Provider package
----------------

This is a provider package for ``{{PROVIDER_PACKAGE_ID}}`` provider. All classes for this provider package
are in ``{{FULL_PACKAGE_NAME}}`` python package.

You can find package information and changelog for the provider
in the `documentation <https://airflow.apache.org/docs/{{ PACKAGE_PIP_NAME }}/{{RELEASE}}/>`_.


Installation
------------

You can install this package on top of an existing Airflow 2 installation (see ``Requirements`` below
for the minimum Airflow version supported) via
``pip install {{PACKAGE_PIP_NAME}}``

The package supports the following python versions: {{ ",".join(SUPPORTED_PYTHON_VERSIONS) }}

{%- if PIP_REQUIREMENTS %}

Requirements
------------

{{  PIP_REQUIREMENTS_TABLE_RST | safe }}

{%- endif %}
{%- if CROSS_PROVIDERS_DEPENDENCIES %}

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 provider packages in order to use them.

You can install such cross-provider dependencies when installing from PyPI. For example:

.. code-block:: bash

    pip install {{ PACKAGE_PIP_NAME }}[{{ CROSS_PROVIDERS_DEPENDENCIES[0] }}]


{{ CROSS_PROVIDERS_DEPENDENCIES_TABLE_RST | safe }}

{%- endif %}

{{ CHANGELOG | safe }}