From b16758d7230f87071f2562e05d537f924b76f241 Mon Sep 17 00:00:00 2001 From: Chris Hronek Date: Tue, 13 Dec 2022 09:26:57 -0700 Subject: [PATCH] Restructure repository to mirror astronomer-providers --- LICENSE | 201 ++++++++++++++++++++++++++++++++ README.md | 57 --------- README.rst | 66 +++++++++++ providers/dbt/__init__.py | 0 providers/dbt/core/__init__.py | 0 providers/dbt/core/operators.py | 6 + setup.cfg | 52 +++++++++ setup.py | 4 + 8 files changed, 329 insertions(+), 57 deletions(-) create mode 100644 LICENSE delete mode 100644 README.md create mode 100644 README.rst create mode 100644 providers/dbt/__init__.py create mode 100644 providers/dbt/core/__init__.py create mode 100644 providers/dbt/core/operators.py create mode 100644 setup.cfg create mode 100644 setup.py diff --git a/LICENSE b/LICENSE new file mode 100644 index 000000000..261eeb9e9 --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed 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. diff --git a/README.md b/README.md deleted file mode 100644 index 3489220cb..000000000 --- a/README.md +++ /dev/null @@ -1,57 +0,0 @@ -# cosmos - -A framework for generating Apache Airflow DAGs from other workflows. - -### Principles - -`cosmos` provides a framework for generating Apache Airflow DAGs from other workflows. Every provider comes with two main components: - -- `extractors`: These are responsible for extracting the workflow from the provider and converting it into `Task` and `Group` objects. -- `operators`: These are used when the workflow is converted into a DAG. They are responsible for executing the tasks in the workflow. - -`cosmos` is not opinionated in the sense that it does not enforce any rendering method. Rather, it comes with the tools to render workflows as Airflow DAGs, task groups, or individual tasks. - -### Example Usage - -Imagine we have a dbt project located at `./dbt/my_project`. - -```python -from cosmos.providers.dbt import DbtDag, DbtTaskGroup, DbtTask - -# render as a DAG -dag = DbtDag( - project_dir="./dbt/my_project", - dag_id="my_dag", - schedule_interval="@daily", - default_args={"owner": "airflow"}, -) - -# render as a task group -with DAG("my_dag", default_args={"owner": "airflow"}) as dag: - task_group = DbtTaskGroup( - project_dir="./dbt/my_project", - task_group_id="my_task_group", - ) - -# render as an individual task -with DAG("my_dag", default_args={"owner": "airflow"}) as dag: - task = DbtTask( - project_dir="./dbt/my_project", - task_id="my_task", - ) -``` - -### Development - -We use pre-commit to run a number of checks on the code before committing. To install pre-commit, run: - -```bash - pip install pre-commit - pre-commit install -``` - -To run the checks manually, run: - -```bash - pre-commit run --all-files -``` diff --git a/README.rst b/README.rst new file mode 100644 index 000000000..80ed11ab3 --- /dev/null +++ b/README.rst @@ -0,0 +1,66 @@ +****** +cosmos +****** + +A framework for generating Apache Airflow DAGs from other workflows. + +Principles +************** + +`cosmos` provides a framework for generating Apache Airflow DAGs from other workflows. Every provider comes with two main components: + +- ``extractors``: These are responsible for extracting the workflow from the provider and converting it into ``Task`` and ``Group`` objects. +- ``operators``: These are used when the workflow is converted into a DAG. They are responsible for executing the tasks in the workflow. + +``cosmos`` is not opinionated in the sense that it does not enforce any rendering method. Rather, it comes with the tools to render workflows as Airflow DAGs, task groups, or individual tasks. + +Example Usage +************** + +Imagine we have a dbt project located at ``./dbt/my_project``. + +.. code-block:: python + + from cosmos.providers.dbt import DbtDag, DbtTaskGroup, DbtTask + + # render as a DAG + dag = DbtDag( + project_dir="./dbt/my_project", + dag_id="my_dag", + schedule_interval="@daily", + default_args={"owner": "airflow"}, + ) + + # render as a task group + with DAG("my_dag", default_args={"owner": "airflow"}) as dag: + task_group = DbtTaskGroup( + project_dir="./dbt/my_project", + task_group_id="my_task_group", + ) + + # render as an individual task + with DAG("my_dag", default_args={"owner": "airflow"}) as dag: + task = DbtTask( + project_dir="./dbt/my_project", + task_id="my_task", + ) + +Development +************** + +We use pre-commit to run a number of checks on the code before committing. To install pre-commit, run: + +.. code-block:: bash + + python3 -m venv venv + source venv/bin/activate + pip install -r dev--requirements.txt + pip install pre-commit + pre-commit install + + +To run the checks manually, run: + +.. code-block:: bash + + pre-commit run --all-files diff --git a/providers/dbt/__init__.py b/providers/dbt/__init__.py new file mode 100644 index 000000000..e69de29bb diff --git a/providers/dbt/core/__init__.py b/providers/dbt/core/__init__.py new file mode 100644 index 000000000..e69de29bb diff --git a/providers/dbt/core/operators.py b/providers/dbt/core/operators.py new file mode 100644 index 000000000..ee39d9c7d --- /dev/null +++ b/providers/dbt/core/operators.py @@ -0,0 +1,6 @@ +from airflow.operators.empty import EmptyOperator + + +class MyCustomOperator(EmptyOperator): + def __init__(self, **kwargs) -> None: + super().__init__(**kwargs) diff --git a/setup.cfg b/setup.cfg new file mode 100644 index 000000000..361854eb7 --- /dev/null +++ b/setup.cfg @@ -0,0 +1,52 @@ +[metadata] +name = cosmos +version = 1.0.0 +url = https://github.com/astronomer/cosmos/ +author = Astronomer +author_email = humans@astronomer.io +description = Apache Airflow Providers containing 3rd party integrations supported natively in Airflow +long_description = file: README.rst +license = Apache License 2.0 +license_files = LICENSE.txt +classifiers = + Development Status :: 5 - Production/Stable + Environment :: Web Environment + Framework :: Apache Airflow + Framework :: Apache Airflow :: Provider + Intended Audience :: Developers + License :: OSI Approved :: Apache Software License + Operating System :: OS Independent + Programming Language :: Python + Programming Language :: Python :: 3 + Programming Language :: Python :: 3.7 + Programming Language :: Python :: 3.8 + Programming Language :: Python :: 3.9 + Programming Language :: Python :: 3.10 +project_urls = + Source Code=https://github.com/astronomer/cosmos/ + Homepage=https://astronomer.io/ + Documentation=https://cosmos.rtfd.io/ + Changelog=https://github.com/astronomer/cosmos/blob/main/CHANGELOG.rst + +[options] +python_requires = >=3.7 +packages = find_namespace: +include_package_data = true +namespace_packages = cosmos,cosmos.providers +install_requires = + apache-airflow>=2.4 + dbt-core==1.3.1 + dbt-postgres==1.3.1 + dbt-snowflake==1.3.0 + dbt-bigquery==1.3.0 + dbt-redshift==1.3.0 +zip_safe = false + +[options.extras_require] +dbt = + dbt-core==1.3.1 + dbt-postgres==1.3.1 + +[options.packages.find] +include = + cosmos.* diff --git a/setup.py b/setup.py new file mode 100644 index 000000000..7f1a1763c --- /dev/null +++ b/setup.py @@ -0,0 +1,4 @@ +from setuptools import setup + +if __name__ == "__main__": + setup()