Astronomer Providers
====================
.. image:: https://badge.fury.io/py/astronomer-providers.svg
:target: https://badge.fury.io/py/astronomer-providers
:alt: PyPI Version
.. image:: https://img.shields.io/pypi/pyversions/astronomer-providers
:target: https://img.shields.io/pypi/pyversions/astronomer-providers
:alt: PyPI - Python Version
.. image:: https://img.shields.io/pypi/l/astronomer-providers?color=blue
:target: https://img.shields.io/pypi/l/astronomer-providers?color=blue
:alt: PyPI - License
.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
:target: https://github.com/psf/black
:alt: Code style: black
.. image:: https://codecov.io/gh/astronomer/astronomer-providers/branch/main/graph/badge.svg?token=LPHFRC3CB3
:target: https://codecov.io/gh/astronomer/astronomer-providers
:alt: CodeCov
.. image:: https://readthedocs.org/projects/astronomer-providers/badge/?version=latest
:target: https://astronomer-providers.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status
.. image:: https://img.shields.io/badge/security-bandit-green.svg
:target: https://github.com/PyCQA/bandit
:alt: Security: bandit
`Apache Airflow <https://airflow.apache.org/>`_ Providers containing Deferrable Operators & Sensors from Astronomer.
Installation
------------
Install and update using `pip <https://pip.pypa.io/en/stable/getting-started/>`_:
.. code-block:: bash
pip install astronomer-providers
This only installs dependencies for core provider. To install all dependencies, run:
.. code-block:: bash
pip install 'astronomer-providers[all]'
To only install the dependencies for a specific provider, specify the integration name as extra argument, example
to install Kubernetes provider dependencies, run:
.. code-block:: bash
pip install 'astronomer-providers[cncf.kubernetes]'
Extras
^^^^^^
.. EXTRA_DOC_START
.. list-table::
:header-rows: 1
* - Extra Name
- Installation Command
- Dependencies
* - ``all``
- ``pip install 'astronomer-providers[all]'``
- All
* - ``amazon``
- ``pip install 'astronomer-providers[amazon]'``
- Amazon
* - ``apache.hive``
- ``pip install 'astronomer-providers[apache.hive]'``
- Apache Hive
* - ``apache.livy``
- ``pip install 'astronomer-providers[apache.livy]'``
- Apache Livy
* - ``cncf.kubernetes``
- ``pip install 'astronomer-providers[cncf.kubernetes]'``
- Cncf Kubernetes
* - ``databricks``
- ``pip install 'astronomer-providers[databricks]'``
- Databricks
* - ``google``
- ``pip install 'astronomer-providers[google]'``
- Google
* - ``microsoft.azure``
- ``pip install 'astronomer-providers[microsoft.azure]'``
- Microsoft Azure
* - ``openlineage``
- ``pip install 'astronomer-providers[openlineage]'``
- Openlineage
* - ``snowflake``
- ``pip install 'astronomer-providers[snowflake]'``
- Snowflake
.. EXTRA_DOC_END
Example Usage
-------------
This repo is structured same as the Apache Airflow's source code, so for example
if you want to import Async operators, you can import it as follows:
.. code-block:: python
from astronomer.providers.amazon.aws.sensors.s3 import S3KeySensorAsync as S3KeySensor
waiting_for_s3_key = S3KeySensor(
task_id="waiting_for_s3_key",
bucket_key="sample_key.txt",
wildcard_match=False,
bucket_name="sample-bucket",
)
**Example DAGs** for each provider is within the respective provider's folder. For example,
the Kubernetes provider's DAGs are within the
`astronomer/providers/cncf/kubernetes/example_dags <https://github.com/astronomer/astronomer-providers/tree/main/astronomer/providers/cncf/kubernetes/example_dags>`_
folder.
Principle
---------
We will only create Async operators for the "sync-version" of operators that do some level of polling
(take more than a few seconds to complete).
For example, we won’t create an async Operator for a ``BigQueryCreateEmptyTableOperator`` but will create one
for ``BigQueryInsertJobOperator`` that actually runs queries and can take hours in the worst case for task completion.
Changelog
---------
We follow `Semantic Versioning <https://semver.org/>`_ for releases.
Check `CHANGELOG.rst <https://github.com/astronomer/astronomer-providers/blob/main/CHANGELOG.rst>`_
for the latest changes.
Contributing Guide
------------------
All contributions, bug reports, bug fixes, documentation improvements, enhancements, and ideas are welcome.
A detailed overview on how to contribute can be found in the
`Contributing Guide <https://github.com/astronomer/astronomer-providers/blob/main/CONTRIBUTING.rst>`_.
As contributors and maintainers to this project, you are expected to abide by the
`Contributor Code of Conduct <https://github.com/astronomer/astronomer-providers/blob/main/CODE_OF_CONDUCT.md>`_.
Goals for the project
---------------------
- Our focus is on the speed of iteration and development in this stage of the project and so we want to be able to
quickly iterate with our community members and customers and cut releases as necessary
- Airflow Providers are separate packages from the core ``apache-airflow`` package and we would like to avoid
further bloating the Airflow repo
- We want users and the community to be able to easily track features and the roadmap for individual providers
that we develop
- We would love to see the Airflow community members create, maintain and share their providers to build an Ecosystem
of Providers.
License
-------
`Apache License 2.0 <LICENSE>`_
Raw data
{
"_id": null,
"home_page": "https://github.com/astronomer/astronomer-providers/",
"name": "astronomer-providers",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "",
"author": "Astronomer",
"author_email": "humans@astronomer.io",
"download_url": "https://files.pythonhosted.org/packages/76/fd/2406c3aed9974debac917c12ce3d8eb57516d24928c7ea1b9b591cdb5202/astronomer-providers-1.6.0.tar.gz",
"platform": null,
"description": "Astronomer Providers\n====================\n\n.. image:: https://badge.fury.io/py/astronomer-providers.svg\n :target: https://badge.fury.io/py/astronomer-providers\n :alt: PyPI Version\n.. image:: https://img.shields.io/pypi/pyversions/astronomer-providers\n :target: https://img.shields.io/pypi/pyversions/astronomer-providers\n :alt: PyPI - Python Version\n.. image:: https://img.shields.io/pypi/l/astronomer-providers?color=blue\n :target: https://img.shields.io/pypi/l/astronomer-providers?color=blue\n :alt: PyPI - License\n.. image:: https://img.shields.io/badge/code%20style-black-000000.svg\n :target: https://github.com/psf/black\n :alt: Code style: black\n.. image:: https://codecov.io/gh/astronomer/astronomer-providers/branch/main/graph/badge.svg?token=LPHFRC3CB3\n :target: https://codecov.io/gh/astronomer/astronomer-providers\n :alt: CodeCov\n.. image:: https://readthedocs.org/projects/astronomer-providers/badge/?version=latest\n :target: https://astronomer-providers.readthedocs.io/en/latest/?badge=latest\n :alt: Documentation Status\n.. image:: https://img.shields.io/badge/security-bandit-green.svg\n :target: https://github.com/PyCQA/bandit\n :alt: Security: bandit\n\n`Apache Airflow <https://airflow.apache.org/>`_ Providers containing Deferrable Operators & Sensors from Astronomer.\n\nInstallation\n------------\n\nInstall and update using `pip <https://pip.pypa.io/en/stable/getting-started/>`_:\n\n.. code-block:: bash\n\n pip install astronomer-providers\n\nThis only installs dependencies for core provider. To install all dependencies, run:\n\n.. code-block:: bash\n\n pip install 'astronomer-providers[all]'\n\nTo only install the dependencies for a specific provider, specify the integration name as extra argument, example\nto install Kubernetes provider dependencies, run:\n\n.. code-block:: bash\n\n pip install 'astronomer-providers[cncf.kubernetes]'\n\nExtras\n^^^^^^\n\n.. EXTRA_DOC_START\n\n.. list-table::\n :header-rows: 1\n\n * - Extra Name\n - Installation Command\n - Dependencies\n\n * - ``all``\n - ``pip install 'astronomer-providers[all]'``\n - All\n\n * - ``amazon``\n - ``pip install 'astronomer-providers[amazon]'``\n - Amazon\n\n * - ``apache.hive``\n - ``pip install 'astronomer-providers[apache.hive]'``\n - Apache Hive\n\n * - ``apache.livy``\n - ``pip install 'astronomer-providers[apache.livy]'``\n - Apache Livy\n\n * - ``cncf.kubernetes``\n - ``pip install 'astronomer-providers[cncf.kubernetes]'``\n - Cncf Kubernetes\n\n * - ``databricks``\n - ``pip install 'astronomer-providers[databricks]'``\n - Databricks\n\n * - ``google``\n - ``pip install 'astronomer-providers[google]'``\n - Google\n\n * - ``microsoft.azure``\n - ``pip install 'astronomer-providers[microsoft.azure]'``\n - Microsoft Azure\n\n * - ``openlineage``\n - ``pip install 'astronomer-providers[openlineage]'``\n - Openlineage\n\n * - ``snowflake``\n - ``pip install 'astronomer-providers[snowflake]'``\n - Snowflake\n\n.. EXTRA_DOC_END\n\nExample Usage\n-------------\n\nThis repo is structured same as the Apache Airflow's source code, so for example\nif you want to import Async operators, you can import it as follows:\n\n.. code-block:: python\n\n from astronomer.providers.amazon.aws.sensors.s3 import S3KeySensorAsync as S3KeySensor\n\n waiting_for_s3_key = S3KeySensor(\n task_id=\"waiting_for_s3_key\",\n bucket_key=\"sample_key.txt\",\n wildcard_match=False,\n bucket_name=\"sample-bucket\",\n )\n\n**Example DAGs** for each provider is within the respective provider's folder. For example,\nthe Kubernetes provider's DAGs are within the\n`astronomer/providers/cncf/kubernetes/example_dags <https://github.com/astronomer/astronomer-providers/tree/main/astronomer/providers/cncf/kubernetes/example_dags>`_\nfolder.\n\nPrinciple\n---------\n\nWe will only create Async operators for the \"sync-version\" of operators that do some level of polling\n(take more than a few seconds to complete).\n\nFor example, we won\u2019t create an async Operator for a ``BigQueryCreateEmptyTableOperator`` but will create one\nfor ``BigQueryInsertJobOperator`` that actually runs queries and can take hours in the worst case for task completion.\n\nChangelog\n---------\n\nWe follow `Semantic Versioning <https://semver.org/>`_ for releases.\nCheck `CHANGELOG.rst <https://github.com/astronomer/astronomer-providers/blob/main/CHANGELOG.rst>`_\nfor the latest changes.\n\nContributing Guide\n------------------\n\nAll contributions, bug reports, bug fixes, documentation improvements, enhancements, and ideas are welcome.\n\nA detailed overview on how to contribute can be found in the\n`Contributing Guide <https://github.com/astronomer/astronomer-providers/blob/main/CONTRIBUTING.rst>`_.\n\nAs contributors and maintainers to this project, you are expected to abide by the\n`Contributor Code of Conduct <https://github.com/astronomer/astronomer-providers/blob/main/CODE_OF_CONDUCT.md>`_.\n\nGoals for the project\n---------------------\n\n- Our focus is on the speed of iteration and development in this stage of the project and so we want to be able to\n quickly iterate with our community members and customers and cut releases as necessary\n- Airflow Providers are separate packages from the core ``apache-airflow`` package and we would like to avoid\n further bloating the Airflow repo\n- We want users and the community to be able to easily track features and the roadmap for individual providers\n that we develop\n- We would love to see the Airflow community members create, maintain and share their providers to build an Ecosystem\n of Providers.\n\nLicense\n-------\n\n`Apache License 2.0 <LICENSE>`_\n",
"bugtrack_url": null,
"license": "Apache License 2.0",
"summary": "Apache Airflow Providers containing Deferrable Operators & Sensors from Astronomer",
"version": "1.6.0",
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "b40df541919add87bc441f4731107ff7",
"sha256": "717929ba50099fad1e4449af2ec838aca342834a5fe7cf3c765c5d7beff2ab6f"
},
"downloads": -1,
"filename": "astronomer_providers-1.6.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b40df541919add87bc441f4731107ff7",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 179945,
"upload_time": "2022-06-28T13:18:29",
"upload_time_iso_8601": "2022-06-28T13:18:29.882411Z",
"url": "https://files.pythonhosted.org/packages/3a/81/6761efe4ef20bf81c41f825c69348240dc8655ceb933439ea4fda5df6681/astronomer_providers-1.6.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"md5": "6f4a4a7a3eeda0029d439e5bd736f2bf",
"sha256": "f48dab72b3695e59c03e649fdb79e2a723ea804fecbcaf4eb9c09e89bfe2964e"
},
"downloads": -1,
"filename": "astronomer-providers-1.6.0.tar.gz",
"has_sig": false,
"md5_digest": "6f4a4a7a3eeda0029d439e5bd736f2bf",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 119125,
"upload_time": "2022-06-28T13:18:31",
"upload_time_iso_8601": "2022-06-28T13:18:31.737195Z",
"url": "https://files.pythonhosted.org/packages/76/fd/2406c3aed9974debac917c12ce3d8eb57516d24928c7ea1b9b591cdb5202/astronomer-providers-1.6.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-06-28 13:18:31",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "astronomer",
"github_project": "astronomer-providers",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "astronomer-providers"
}
JSON
