chore: Add __main__.py entry point to samples and cookiecutters (#2156

)

* chore: Add `__main__.py` entry point to samples and cookiecutters

* Add missing key to replay files

cookiecutter/mapper-template/cookiecutter.json

@@ -7,13 +7,15 @@
   "variant": "None (Skip)",
   "include_ci_files": ["GitHub", "None (Skip)"],
   "license": ["Apache-2.0"],
+  "ide": ["VSCode", "None"],
   "__prompts__": {
     "name": "The name of the mapper, in CamelCase",
     "admin_name": "Provide your [bold yellow]full name[/]",
     "admin_email": "Provide your [bold yellow]email[/]",
     "mapper_id": "The ID of the tap, in kebab-case",
     "library_name": "The name of the library, in snake_case. This is how the library will be imported in Python.",
     "include_ci_files": "Whether to include CI files for a common CI services",
-    "license": "The license for the project"
+    "license": "The license for the project",
+    "ide": "Add configuration files for your preferred IDE"
   }
 }

cookiecutter/mapper-template/hooks/post_gen_project.py

@@ -0,0 +1,17 @@
+#!/usr/bin/env python
+from pathlib import Path
+import shutil
+
+
+BASE_PATH = Path("{{cookiecutter.library_name}}")
+
+
+if __name__ == "__main__":
+    if "{{ cookiecutter.license }}" != "Apache-2.0":
+        Path("LICENSE").unlink()
+
+    if "{{ cookiecutter.include_ci_files }}" != "GitHub":
+        shutil.rmtree(Path(".github"))
+
+    if "{{ cookiecutter.ide }}" != "VSCode":
+        shutil.rmtree(".vscode")

cookiecutter/mapper-template/{{cookiecutter.mapper_id}}/{{cookiecutter.library_name}}/__main__.py

@@ -0,0 +1,7 @@
+"""{{ cookiecutter.name }} entry point."""
+
+from __future__ import annotations
+
+from {{ cookiecutter.library_name }}.mapper import {{ cookiecutter.name }}Mapper
+
+{{ cookiecutter.name }}Mapper.cli()

cookiecutter/tap-template/cookiecutter.json

@@ -16,6 +16,7 @@
   ],
   "include_ci_files": ["GitHub", "None"],
   "license": ["Apache-2.0", "None"],
+  "ide": ["VSCode", "None"],
   "__prompts__": {
     "source_name": "The name of the source, in CamelCase",
     "admin_name": "Provide your [bold yellow]full name[/]",
@@ -25,6 +26,7 @@
     "stream_type": "The type of stream the source provides",
     "auth_method": "The [bold red]authentication[/] method used by the source, for REST and GraphQL sources",
     "include_ci_files": "Whether to include CI files for a common CI services",
-    "license": "The license for the project"
+    "license": "The license for the project",
+    "ide": "Add configuration files for your preferred IDE"
   }
 }

cookiecutter/tap-template/hooks/post_gen_project.py

@@ -26,3 +26,6 @@
 
     if "{{ cookiecutter.include_ci_files }}" != "GitHub":
         shutil.rmtree(".github")
+
+    if "{{ cookiecutter.ide }}" != "VSCode":
+        shutil.rmtree(".vscode")

cookiecutter/tap-template/{{cookiecutter.tap_id}}/{{cookiecutter.library_name}}/__main__.py

@@ -0,0 +1,7 @@
+"""{{ cookiecutter.source_name }} entry point."""
+
+from __future__ import annotations
+
+from {{ cookiecutter.library_name }}.tap import Tap{{ cookiecutter.source_name }}
+
+Tap{{ cookiecutter.source_name }}.cli()

cookiecutter/target-template/cookiecutter.json

@@ -8,6 +8,7 @@
   "serialization_method": ["Per record", "Per batch", "SQL"],
   "include_ci_files": ["GitHub", "None (Skip)"],
   "license": ["Apache-2.0"],
+  "ide": ["VSCode", "None"],
   "__prompts__": {
     "name": "The name of the mapper, in CamelCase",
     "admin_name": "Provide your [bold yellow]full name[/]",
@@ -16,6 +17,7 @@
     "library_name": "The name of the library, in snake_case. This is how the library will be imported in Python.",
     "serialization_method": "The serialization method to use for loading data",
     "include_ci_files": "Whether to include CI files for a common CI services",
-    "license": "The license for the project"
+    "license": "The license for the project",
+    "ide": "Add configuration files for your preferred IDE"
   }
 }

cookiecutter/target-template/hooks/post_gen_project.py

@@ -12,3 +12,6 @@
 
     if "{{ cookiecutter.include_ci_files }}" != "GitHub":
         shutil.rmtree(Path(".github"))
+
+    if "{{ cookiecutter.ide }}" != "VSCode":
+        shutil.rmtree(".vscode")

cookiecutter/target-template/{{cookiecutter.target_id}}/{{cookiecutter.library_name}}/__main__.py

@@ -0,0 +1,7 @@
+"""{{ cookiecutter.destination_name }} entry point."""
+
+from __future__ import annotations
+
+from {{ cookiecutter.library_name }}.target import Target{{ cookiecutter.destination_name }}
+
+Target{{ cookiecutter.destination_name }}.cli()

e2e-tests/cookiecutters/mapper-base.json

@@ -8,6 +8,7 @@
       "variant": "None (Skip)",
       "include_ci_files": "None (Skip)",
       "license": "Apache-2.0",
+      "ide": "VSCode",
       "_template": "../mapper-template/",
       "_output_dir": "."
     }

e2e-tests/cookiecutters/tap-graphql-jwt.json

@@ -10,6 +10,7 @@
       "auth_method": "JWT",
       "include_ci_files": "None (Skip)",
       "license": "Apache-2.0",
+      "ide": "VSCode",
       "_template": "../tap-template/",
       "_output_dir": "."
     }

e2e-tests/cookiecutters/tap-other-custom.json

@@ -10,6 +10,7 @@
       "auth_method": "Custom or N/A",
       "include_ci_files": "None (Skip)",
       "license": "Apache-2.0",
+      "ide": "VSCode",
       "_template": "../tap-template/",
       "_output_dir": "."
     }

e2e-tests/cookiecutters/tap-rest-api_key-github.json

@@ -10,6 +10,7 @@
       "auth_method": "API Key",
       "include_ci_files": "GitHub",
       "license": "Apache-2.0",
+      "ide": "VSCode",
       "_template": "../tap-template/",
       "_output_dir": "."
     }

e2e-tests/cookiecutters/tap-rest-basic_auth.json

@@ -10,6 +10,7 @@
       "auth_method": "Basic Auth",
       "include_ci_files": "None (Skip)",
       "license": "Apache-2.0",
+      "ide": "VSCode",
       "_template": "../tap-template/",
       "_output_dir": "."
     }

e2e-tests/cookiecutters/tap-rest-bearer_token.json

@@ -10,6 +10,7 @@
       "auth_method": "Bearer Token",
       "include_ci_files": "None (Skip)",
       "license": "Apache-2.0",
+      "ide": "VSCode",
       "_template": "../tap-template/",
       "_output_dir": "."
     }

e2e-tests/cookiecutters/tap-rest-custom.json

@@ -10,6 +10,7 @@
       "auth_method": "Custom or N/A",
       "include_ci_files": "None (Skip)",
       "license": "Apache-2.0",
+      "ide": "VSCode",
       "_template": "../tap-template/",
       "_output_dir": "."
     }

e2e-tests/cookiecutters/tap-rest-jwt.json

@@ -10,6 +10,7 @@
       "auth_method": "JWT",
       "include_ci_files": "None (Skip)",
       "license": "Apache-2.0",
+      "ide": "VSCode",
       "_template": "../tap-template/",
       "_output_dir": "."
     }

e2e-tests/cookiecutters/tap-rest-oauth2.json

@@ -10,6 +10,7 @@
       "auth_method": "OAuth2",
       "include_ci_files": "None (Skip)",
       "license": "Apache-2.0",
+      "ide": "VSCode",
       "_template": "../tap-template/",
       "_output_dir": "."
     }

e2e-tests/cookiecutters/tap-sql-custom.json

@@ -10,6 +10,7 @@
       "auth_method": "Custom or N/A",
       "include_ci_files": "None (Skip)",
       "license": "Apache-2.0",
+      "ide": "VSCode",
       "_template": "../tap-template/",
       "_output_dir": "."
     }

e2e-tests/cookiecutters/target-per_record.json

@@ -9,6 +9,7 @@
       "serialization_method": "Per record",
       "include_ci_files": "None (Skip)",
       "license": "Apache-2.0",
+      "ide": "VSCode",
       "_template": "./sdk/cookiecutter/target-template",
       "_output_dir": "."
     }

e2e-tests/cookiecutters/target-sql.json

@@ -9,6 +9,7 @@
       "serialization_method": "SQL",
       "include_ci_files": "None (Skip)",
       "license": "Apache-2.0",
+      "ide": "VSCode",
       "_template": "./sdk/cookiecutter/target-template",
       "_output_dir": "."
     }

samples/sample_mapper/__main__.py

@@ -0,0 +1,5 @@
+from __future__ import annotations
+
+from samples.sample_mapper.mapper import StreamTransform
+
+StreamTransform.cli()

samples/sample_tap_bigquery/__main__.py

@@ -0,0 +1,5 @@
+from __future__ import annotations
+
+from samples.sample_tap_bigquery import TapBigQuery
+
+TapBigQuery.cli()

samples/sample_tap_gitlab/__main__.py

@@ -0,0 +1,5 @@
+from __future__ import annotations
+
+from sample_tap_gitlab.gitlab_tap import SampleTapGitlab
+
+SampleTapGitlab.cli()

samples/sample_tap_google_analytics/__main__.py

@@ -0,0 +1,5 @@
+from __future__ import annotations
+
+from samples.sample_tap_google_analytics.ga_tap import SampleTapGoogleAnalytics
+
+SampleTapGoogleAnalytics.cli()

samples/sample_tap_hostile/__main__.py

@@ -0,0 +1,5 @@
+from __future__ import annotations
+
+from samples.sample_tap_hostile import SampleTapHostile
+
+SampleTapHostile.cli()

samples/sample_tap_sqlite/__main__.py

@@ -0,0 +1,5 @@
+from __future__ import annotations
+
+from samples.sample_tap_sqlite import SQLiteTap
+
+SQLiteTap.cli()

samples/sample_target_parquet/__main__.py

@@ -0,0 +1,5 @@
+from __future__ import annotations
+
+from sample_target_parquet.parquet_target import SampleTargetParquet
+
+SampleTargetParquet.cli()