From de97f0f87db2d76e784940b6e7ac5c29ab40d5ae Mon Sep 17 00:00:00 2001 From: Felix Uellendall Date: Tue, 10 Jan 2023 14:51:42 +0100 Subject: [PATCH] Move "include" directory to project (#1560) # Description ## What is the current behavior? See the referenced issue for details. closes: #1440 ## What is the new behavior? After reading https://github.com/python-poetry/poetry/issues/2015, it seems the best solution is to include the "include" directory directly in the project. ## Does this introduce a breaking change? No. ### Checklist - [x] Created tests which fail without the change (if possible) - [ ] Extended the README / documentation, if necessary --- .gitignore | 7 ++----- sql-cli/pyproject.toml | 3 --- .../include/base/.airflow/dags/.gitkeep | 0 .../include/base/.airflow/dags/include/.gitkeep | 0 .../include/base/.airflow/default/.gitkeep | 0 .../include/base/.airflow/dev/.gitkeep | 0 sql-cli/{ => sql_cli}/include/base/.env | 0 .../include/base/config/default/configuration.yml | 0 .../include/base/config/dev/configuration.yml | 0 .../{ => sql_cli}/include/base/config/global.yml | 0 sql-cli/{ => sql_cli}/include/base/data/imdb.db | Bin sql-cli/{ => sql_cli}/include/base/data/retail.db | Bin .../example_basic_transform/top_animations.sql | 0 .../example_load_file/load_imdb_movies.yaml | 0 .../example_load_file/transform_imdb_movies.sql | 0 .../example_templating/filtered_orders.sql | 0 .../example_templating/joint_orders_customers.sql | 0 sql-cli/sql_cli/project.py | 2 +- sql-cli/tests/test_configuration.py | 9 +++------ 19 files changed, 6 insertions(+), 15 deletions(-) rename sql-cli/{ => sql_cli}/include/base/.airflow/dags/.gitkeep (100%) rename sql-cli/{ => sql_cli}/include/base/.airflow/dags/include/.gitkeep (100%) rename sql-cli/{ => sql_cli}/include/base/.airflow/default/.gitkeep (100%) rename sql-cli/{ => sql_cli}/include/base/.airflow/dev/.gitkeep (100%) rename sql-cli/{ => sql_cli}/include/base/.env (100%) rename sql-cli/{ => sql_cli}/include/base/config/default/configuration.yml (100%) rename sql-cli/{ => sql_cli}/include/base/config/dev/configuration.yml (100%) rename sql-cli/{ => sql_cli}/include/base/config/global.yml (100%) rename sql-cli/{ => sql_cli}/include/base/data/imdb.db (100%) rename sql-cli/{ => sql_cli}/include/base/data/retail.db (100%) rename sql-cli/{ => sql_cli}/include/base/workflows/example_basic_transform/top_animations.sql (100%) rename sql-cli/{ => sql_cli}/include/base/workflows/example_load_file/load_imdb_movies.yaml (100%) rename sql-cli/{ => sql_cli}/include/base/workflows/example_load_file/transform_imdb_movies.sql (100%) rename sql-cli/{ => sql_cli}/include/base/workflows/example_templating/filtered_orders.sql (100%) rename sql-cli/{ => sql_cli}/include/base/workflows/example_templating/joint_orders_customers.sql (100%) diff --git a/.gitignore b/.gitignore index 7ebe066a7d..bc8da2bd59 100644 --- a/.gitignore +++ b/.gitignore @@ -53,11 +53,8 @@ sql-cli/tests/.airflow/dags/* !sql-cli/tests/.airflow/dags/sql/.gitkeep !sql-cli/tests/.airflow/dags/.gitkeep -# Generated examples -sql-cli/include/base/.airflow/dags/* -!sql-cli/include/base/.airflow/dags/include/.gitkeep -!sql-cli/include/base/.airflow/dags/.gitkeep -!/sql-cli/include/base/.env +# Un-ignore .env file for sql-cli users +!sql-cli/sql_cli/include/base/.env # Airflow **/.airflowignore diff --git a/sql-cli/pyproject.toml b/sql-cli/pyproject.toml index 81008c3ad4..17ae43d46f 100644 --- a/sql-cli/pyproject.toml +++ b/sql-cli/pyproject.toml @@ -20,9 +20,6 @@ classifiers = [ "Programming Language :: Python :: 3.9", "Programming Language :: Python :: 3.10", ] -include=[ - { path = 'include', format = 'wheel' } -] [project.urls] Home = "https://astronomer.io/" diff --git a/sql-cli/include/base/.airflow/dags/.gitkeep b/sql-cli/sql_cli/include/base/.airflow/dags/.gitkeep similarity index 100% rename from sql-cli/include/base/.airflow/dags/.gitkeep rename to sql-cli/sql_cli/include/base/.airflow/dags/.gitkeep diff --git a/sql-cli/include/base/.airflow/dags/include/.gitkeep b/sql-cli/sql_cli/include/base/.airflow/dags/include/.gitkeep similarity index 100% rename from sql-cli/include/base/.airflow/dags/include/.gitkeep rename to sql-cli/sql_cli/include/base/.airflow/dags/include/.gitkeep diff --git a/sql-cli/include/base/.airflow/default/.gitkeep b/sql-cli/sql_cli/include/base/.airflow/default/.gitkeep similarity index 100% rename from sql-cli/include/base/.airflow/default/.gitkeep rename to sql-cli/sql_cli/include/base/.airflow/default/.gitkeep diff --git a/sql-cli/include/base/.airflow/dev/.gitkeep b/sql-cli/sql_cli/include/base/.airflow/dev/.gitkeep similarity index 100% rename from sql-cli/include/base/.airflow/dev/.gitkeep rename to sql-cli/sql_cli/include/base/.airflow/dev/.gitkeep diff --git a/sql-cli/include/base/.env b/sql-cli/sql_cli/include/base/.env similarity index 100% rename from sql-cli/include/base/.env rename to sql-cli/sql_cli/include/base/.env diff --git a/sql-cli/include/base/config/default/configuration.yml b/sql-cli/sql_cli/include/base/config/default/configuration.yml similarity index 100% rename from sql-cli/include/base/config/default/configuration.yml rename to sql-cli/sql_cli/include/base/config/default/configuration.yml diff --git a/sql-cli/include/base/config/dev/configuration.yml b/sql-cli/sql_cli/include/base/config/dev/configuration.yml similarity index 100% rename from sql-cli/include/base/config/dev/configuration.yml rename to sql-cli/sql_cli/include/base/config/dev/configuration.yml diff --git a/sql-cli/include/base/config/global.yml b/sql-cli/sql_cli/include/base/config/global.yml similarity index 100% rename from sql-cli/include/base/config/global.yml rename to sql-cli/sql_cli/include/base/config/global.yml diff --git a/sql-cli/include/base/data/imdb.db b/sql-cli/sql_cli/include/base/data/imdb.db similarity index 100% rename from sql-cli/include/base/data/imdb.db rename to sql-cli/sql_cli/include/base/data/imdb.db diff --git a/sql-cli/include/base/data/retail.db b/sql-cli/sql_cli/include/base/data/retail.db similarity index 100% rename from sql-cli/include/base/data/retail.db rename to sql-cli/sql_cli/include/base/data/retail.db diff --git a/sql-cli/include/base/workflows/example_basic_transform/top_animations.sql b/sql-cli/sql_cli/include/base/workflows/example_basic_transform/top_animations.sql similarity index 100% rename from sql-cli/include/base/workflows/example_basic_transform/top_animations.sql rename to sql-cli/sql_cli/include/base/workflows/example_basic_transform/top_animations.sql diff --git a/sql-cli/include/base/workflows/example_load_file/load_imdb_movies.yaml b/sql-cli/sql_cli/include/base/workflows/example_load_file/load_imdb_movies.yaml similarity index 100% rename from sql-cli/include/base/workflows/example_load_file/load_imdb_movies.yaml rename to sql-cli/sql_cli/include/base/workflows/example_load_file/load_imdb_movies.yaml diff --git a/sql-cli/include/base/workflows/example_load_file/transform_imdb_movies.sql b/sql-cli/sql_cli/include/base/workflows/example_load_file/transform_imdb_movies.sql similarity index 100% rename from sql-cli/include/base/workflows/example_load_file/transform_imdb_movies.sql rename to sql-cli/sql_cli/include/base/workflows/example_load_file/transform_imdb_movies.sql diff --git a/sql-cli/include/base/workflows/example_templating/filtered_orders.sql b/sql-cli/sql_cli/include/base/workflows/example_templating/filtered_orders.sql similarity index 100% rename from sql-cli/include/base/workflows/example_templating/filtered_orders.sql rename to sql-cli/sql_cli/include/base/workflows/example_templating/filtered_orders.sql diff --git a/sql-cli/include/base/workflows/example_templating/joint_orders_customers.sql b/sql-cli/sql_cli/include/base/workflows/example_templating/joint_orders_customers.sql similarity index 100% rename from sql-cli/include/base/workflows/example_templating/joint_orders_customers.sql rename to sql-cli/sql_cli/include/base/workflows/example_templating/joint_orders_customers.sql diff --git a/sql-cli/sql_cli/project.py b/sql-cli/sql_cli/project.py index 2e83653d1d..cdbe64a325 100644 --- a/sql-cli/sql_cli/project.py +++ b/sql-cli/sql_cli/project.py @@ -23,7 +23,7 @@ remove_unnecessary_files, ) -BASE_SOURCE_DIR = Path(os.path.realpath(__file__)).parent.parent / "include/base/" +BASE_SOURCE_DIR = Path(os.path.realpath(__file__)).parent / "include/base/" MANDATORY_PATHS = { Path("config/default/configuration.yml"), diff --git a/sql-cli/tests/test_configuration.py b/sql-cli/tests/test_configuration.py index b3e7b60469..46864904bb 100644 --- a/sql-cli/tests/test_configuration.py +++ b/sql-cli/tests/test_configuration.py @@ -1,12 +1,9 @@ -from pathlib import Path - from sql_cli.configuration import Config +from sql_cli.project import BASE_SOURCE_DIR def test_from_yaml_to_config(): - config_reference = Config( - project_dir=Path(__file__).parent.parent / "include/base", environment="default" - ) + config_reference = Config(project_dir=BASE_SOURCE_DIR, environment="default") config_from_file = config_reference.from_yaml_to_config() assert isinstance(config_from_file, Config) assert config_from_file.project_dir == config_reference.project_dir @@ -15,7 +12,7 @@ def test_from_yaml_to_config(): def test_from_yaml_to_config_without_env(): - config_reference = Config(project_dir=Path(__file__).parent.parent / "include/base") + config_reference = Config(project_dir=BASE_SOURCE_DIR) config_from_file = config_reference.from_yaml_to_config() assert isinstance(config_from_file, Config) assert config_from_file.project_dir == config_reference.project_dir