From 882bb7d7621538ee042274eff80fd1ad898771f3 Mon Sep 17 00:00:00 2001
From: fritz-astronomer <80706212+fritz-astronomer@users.noreply.github.com>
Date: Mon, 26 Aug 2024 18:45:38 -0400
Subject: [PATCH] Repository Initialization; devops, structure
---
.gitignore | 11 ++
.pre-commit-config.yaml | 51 ++++++++
.secrets.baseline | 127 +++++++++++++++++++
LICENSE | 201 +++++++++++++++++++++++++++++++
README.md | 22 ++++
justfile | 56 +++++++++
orbiter_translations/__init__.py | 3 +
pyproject.toml | 118 ++++++++++++++++++
tests/__init__.py | 0
tests/conftest.py | 14 +++
10 files changed, 603 insertions(+)
create mode 100644 .gitignore
create mode 100644 .pre-commit-config.yaml
create mode 100644 .secrets.baseline
create mode 100644 LICENSE
create mode 100644 README.md
create mode 100644 justfile
create mode 100644 orbiter_translations/__init__.py
create mode 100644 pyproject.toml
create mode 100644 tests/__init__.py
create mode 100644 tests/conftest.py
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..f97feec
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,11 @@
+.idea
+.DS_Store
+*venv*
+*__pycache__*
+*.pyc
+*.egg-info
+dist
+site
+build
+*output*
+__pycache__
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
new file mode 100644
index 0000000..b803f29
--- /dev/null
+++ b/.pre-commit-config.yaml
@@ -0,0 +1,51 @@
+default_language_version:
+ python: python3
+
+default_stages: [ commit, push ]
+
+repos:
+ - repo: https://github.com/pre-commit/pre-commit-hooks
+ rev: v4.6.0
+ hooks:
+ - id: trailing-whitespace
+ - id: end-of-file-fixer
+ - id: check-yaml
+ args: ["--unsafe"]
+ - id: check-json
+ - id: check-toml
+ - id: check-added-large-files
+ - id: check-merge-conflict
+ - id: check-vcs-permalinks
+ - id: debug-statements
+ - id: detect-private-key
+ - id: name-tests-test
+ - id: trailing-whitespace
+ - id: detect-aws-credentials
+ args: [ "--allow-missing-credentials" ]
+
+ - repo: https://github.com/Yelp/detect-secrets
+ rev: v1.5.0
+ hooks:
+ - id: detect-secrets
+ args: [ '--baseline', '.secrets.baseline' ]
+
+ - repo: https://github.com/sirosen/texthooks
+ rev: 0.6.7
+ hooks: [ { id: fix-smartquotes }, { id: fix-ligatures } ]
+
+ - repo: https://github.com/charliermarsh/ruff-pre-commit
+ rev: 'v0.6.0'
+ hooks:
+ - id: ruff
+ args: [ --fix, --exit-non-zero-on-fix ]
+
+ - repo: https://github.com/psf/black
+ rev: 24.8.0
+ hooks: [ { id: black, args: [ --config=pyproject.toml ] } ]
+
+ - repo: https://github.com/PyCQA/bandit/
+ rev: 1.7.9
+ hooks:
+ - id: bandit
+ args: [ "-c", "pyproject.toml" ]
+ additional_dependencies: [ "bandit[toml]" ]
diff --git a/.secrets.baseline b/.secrets.baseline
new file mode 100644
index 0000000..50d02a9
--- /dev/null
+++ b/.secrets.baseline
@@ -0,0 +1,127 @@
+{
+ "version": "1.5.0",
+ "plugins_used": [
+ {
+ "name": "ArtifactoryDetector"
+ },
+ {
+ "name": "AWSKeyDetector"
+ },
+ {
+ "name": "AzureStorageKeyDetector"
+ },
+ {
+ "name": "Base64HighEntropyString",
+ "limit": 4.5
+ },
+ {
+ "name": "BasicAuthDetector"
+ },
+ {
+ "name": "CloudantDetector"
+ },
+ {
+ "name": "DiscordBotTokenDetector"
+ },
+ {
+ "name": "GitHubTokenDetector"
+ },
+ {
+ "name": "GitLabTokenDetector"
+ },
+ {
+ "name": "HexHighEntropyString",
+ "limit": 3.0
+ },
+ {
+ "name": "IbmCloudIamDetector"
+ },
+ {
+ "name": "IbmCosHmacDetector"
+ },
+ {
+ "name": "IPPublicDetector"
+ },
+ {
+ "name": "JwtTokenDetector"
+ },
+ {
+ "name": "KeywordDetector",
+ "keyword_exclude": ""
+ },
+ {
+ "name": "MailchimpDetector"
+ },
+ {
+ "name": "NpmDetector"
+ },
+ {
+ "name": "OpenAIDetector"
+ },
+ {
+ "name": "PrivateKeyDetector"
+ },
+ {
+ "name": "PypiTokenDetector"
+ },
+ {
+ "name": "SendGridDetector"
+ },
+ {
+ "name": "SlackDetector"
+ },
+ {
+ "name": "SoftlayerDetector"
+ },
+ {
+ "name": "SquareOAuthDetector"
+ },
+ {
+ "name": "StripeDetector"
+ },
+ {
+ "name": "TelegramBotTokenDetector"
+ },
+ {
+ "name": "TwilioKeyDetector"
+ }
+ ],
+ "filters_used": [
+ {
+ "path": "detect_secrets.filters.allowlist.is_line_allowlisted"
+ },
+ {
+ "path": "detect_secrets.filters.common.is_ignored_due_to_verification_policies",
+ "min_level": 2
+ },
+ {
+ "path": "detect_secrets.filters.heuristic.is_indirect_reference"
+ },
+ {
+ "path": "detect_secrets.filters.heuristic.is_likely_id_string"
+ },
+ {
+ "path": "detect_secrets.filters.heuristic.is_lock_file"
+ },
+ {
+ "path": "detect_secrets.filters.heuristic.is_not_alphanumeric_string"
+ },
+ {
+ "path": "detect_secrets.filters.heuristic.is_potential_uuid"
+ },
+ {
+ "path": "detect_secrets.filters.heuristic.is_prefixed_with_dollar_sign"
+ },
+ {
+ "path": "detect_secrets.filters.heuristic.is_sequential_string"
+ },
+ {
+ "path": "detect_secrets.filters.heuristic.is_swagger_file"
+ },
+ {
+ "path": "detect_secrets.filters.heuristic.is_templated_secret"
+ }
+ ],
+ "results": {},
+ "generated_at": "2024-08-16T05:22:20Z"
+}
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..261eeb9
--- /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
new file mode 100644
index 0000000..d4c721f
--- /dev/null
+++ b/README.md
@@ -0,0 +1,22 @@
+
+
+ 
+
+
+ Astronomer Orbiter can land legacy workloads safely down in a new home on Apache Airflow!
+
+
+
+## What is it?
+`orbiter` is a framework and CLI that runs on your workstation and converts workflow definitions from other tools to Airflow Projects.
+
+[Read more at the official documentation!](https://astronomer.github.io/orbiter)
+
+# Artwork
+Orbiter logo [by Ivan Colic](https://thenounproject.com/Ivanisawesome/) used with permission
+from [The Noun Project](https://thenounproject.com/icon/lunar-orbiter-196219/)
+under [Creative Commons](https://creativecommons.org/licenses/by/3.0/us/legalcode).
diff --git a/justfile b/justfile
new file mode 100644
index 0000000..0d4fc72
--- /dev/null
+++ b/justfile
@@ -0,0 +1,56 @@
+#!/usr/bin/env just --justfile
+set dotenv-load := true
+EXTRAS := "dev"
+VERSION := `echo $(python -c 'from orbiter_translations import __version__; print(__version__)')`
+
+default:
+ @just --choose
+
+# Print this help text
+help:
+ @just --list
+
+# Install project and python dependencies (incl. pre-commit) locally
+install EDITABLE='':
+ pip install {{EDITABLE}} '.[{{EXTRAS}}]'
+
+# Install pre-commit to local project
+install-precommit: install
+ pre-commit install
+
+# Update the baseline for detect-secrets / pre-commit
+update-secrets:
+ detect-secrets scan > .secrets.baseline # pragma: allowlist secret
+
+# Run pytests with config from pyproject.toml
+test:
+ pytest -c pyproject.toml
+
+# Test and emit a coverage report
+test-with-coverage:
+ pytest -c pyproject.toml --cov=./ --cov-report=xml
+
+# Run ruff and black (normally done with pre-commit)
+lint:
+ ruff check .
+
+# Remove temporary or build folders
+clean:
+ rm -rf build dist site *.egg-info
+ find . | grep -E "(__pycache__|\.pyc|\.pyo$$)" | xargs rm -rf
+
+# Tag as v$(.__version__) and push to GH
+tag:
+ # Delete tag if it already exists
+ git tag -d v{{VERSION}} || true
+ # Tag and push
+ git tag v{{VERSION}}
+
+deploy-tag: tag
+ git push origin v{{VERSION}}
+
+deploy: deploy-tag
+
+# Build the project
+build: install clean
+ python -m build
diff --git a/orbiter_translations/__init__.py b/orbiter_translations/__init__.py
new file mode 100644
index 0000000..fbe291e
--- /dev/null
+++ b/orbiter_translations/__init__.py
@@ -0,0 +1,3 @@
+__version__ = "0.2.0"
+
+version = __version__
diff --git a/pyproject.toml b/pyproject.toml
new file mode 100644
index 0000000..8d29939
--- /dev/null
+++ b/pyproject.toml
@@ -0,0 +1,118 @@
+[build-system]
+requires = ["setuptools >= 68.0"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools]
+include-package-data = false
+
+[tool.setuptools.dynamic]
+version = { attr = "orbiter_translations.__version__" }
+
+[tool.setuptools.packages.find]
+exclude = [
+ "*venv", "*venv.*",
+ "*tests.*", "*tests",
+ "*build", "*build.*",
+ "*dist", "*dist.*"
+]
+
+[project]
+dynamic = ["version"]
+name = "orbiter-community-translations"
+description = "Astronomer Orbiter can take your legacy workloads and land them safely down in a new home on Apache Airflow!"
+readme = "README.md"
+authors = [
+ { name = "Fritz Davenport", email = "fritz@astronomer.io" },
+ { name = "CETA Team", email = "ceta@astronomer.io" },
+ { name = "Astronomer", email = "humans@astronomer.io" },
+]
+license = { file = "LICENSE" }
+requires-python = ">= 3.10"
+dependencies = [
+ # for converting to snake_case
+ "inflection",
+
+ # for templating within @rules
+ "jinja2",
+
+ # for merging defaults dict in DAG-Factory @rules
+ "deepmerge",
+
+ # for deep-parsing dicts within @rules
+ "jq",
+
+ # logging
+ "loguru",
+
+ # backport
+ "eval_type_backport; python_version < '3.10'",
+]
+
+[project.optional-dependencies]
+dev = [
+ # for testing
+ "astronomer-orbiter",
+
+ # package
+ "build",
+ "twine>=4.0.2",
+
+ # for generating docs
+ "mkdocs",
+ "mkdocs-click",
+ "mkdocs-material",
+ "mkdocstrings-python",
+ "pygments",
+
+ # test
+ "pytest>=7.4",
+ "pytest-cov>=4.1",
+ "pytest-sugar>=0.9.7",
+ "pytest-mock",
+
+ # lint
+ "black>=23.12.0",
+ "ruff>=0.1.0",
+ "pylint>=3.0.0",
+ "isort>=5.13.0",
+
+ # pre-commit
+ "pre-commit>=3.6.0; python_version >= '3.9'",
+ "detect-secrets>=1.4.0",
+]
+
+
+[project.urls]
+Homepage = "https://astronomer.io"
+Source = "https://github.com/astronomer/orbiter-community-translations"
+
+[tool.bandit]
+exclude_dirs = ["tests"]
+skips = []
+
+[tool.black]
+# https://github.com/psf/black
+color = true
+
+[tool.ruff]
+line-length = 120
+
+[tool.pytest.ini_options]
+pythonpath = ["."]
+norecursedirs = [
+ "*expected*", "*output*", "*dags/", "*dags/*",
+ "venv", "*.egg", ".eggs", "dist", "build", "docs", ".tox", ".git", "__pycache__"
+]
+testpaths = ["orbiter_translations", "tests"]
+
+doctest_optionflags = ["ELLIPSIS", "NUMBER", "NORMALIZE_WHITESPACE", "IGNORE_EXCEPTION_DETAIL"]
+addopts = [
+ "-s",
+ "--continue-on-collection-errors",
+ "--strict-markers",
+ "--tb=short",
+ "--disable-warnings",
+ "--no-header",
+ "--doctest-modules",
+ "--doctest-continue-on-failure",
+]
diff --git a/tests/__init__.py b/tests/__init__.py
new file mode 100644
index 0000000..e69de29
diff --git a/tests/conftest.py b/tests/conftest.py
new file mode 100644
index 0000000..44ac47d
--- /dev/null
+++ b/tests/conftest.py
@@ -0,0 +1,14 @@
+from pathlib import Path
+
+import pytest
+
+
+@pytest.fixture(scope="session")
+def project_root() -> Path:
+ return Path(__file__).parent.parent
+
+
+@pytest.fixture(autouse=True)
+def change_test_dir(request, monkeypatch):
+ """Credit: https://stackoverflow.com/a/62055409"""
+ monkeypatch.chdir(request.fspath.dirname)