laketower 0.6.0__tar.gz → 0.6.1__tar.gz

{laketower-0.6.0 → laketower-0.6.1}/.github/workflows/ci-cd.yml

@@ -78,7 +78,7 @@ jobs:
       - name: Export code coverage report to job summary
         run: cat "${CODECOV_MD_FILE}" >> "${GITHUB_STEP_SUMMARY}"
       - name: Add or update code coverage comment to pull request
-        uses: actions/github-script@v7
+        uses: actions/github-script@v8
         if: ${{ github.event_name == 'pull_request' }}
         with:
           script: |

{laketower-0.6.0 → laketower-0.6.1}/.gitignore

@@ -7,6 +7,9 @@ wheels/
 *.egg-info
 .coverage
 
+# Node.js
+node_modules/
+
 # Virtual environments
 .venv
 

{laketower-0.6.0 → laketower-0.6.1}/CHANGELOG.md

@@ -7,6 +7,30 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.6.1] - 2025-09-11
+Patch release with minor enhancements (SQL syntax highlighting, query parameters,
+predefined query Markdown description) and quality of life improvements
+(hide read-only SQL editor in predefined queries, web app offline usage).
+
+### Added
+- web: display app version in sidebar
+- web: use CodeMirror SQL query editor
+- web: add support for tables query parameters
+- web: add support for predefined queries parameters
+- web: add optional markdown description for predefined queries
+- cli: add support for tables query parameters
+- cli: add support for predefined queries parameters
+
+### Changed
+- web: hide SQL editor for predefined queries
+- demo: add parameters to daily avg temperature query
+
+### Fixed
+- handle empty SQL queries
+
+### Misc
+- vendor static assets for offline usage
+
 ## [0.6.0] - 2025-08-27
 Minor release with new features (CSV import/export, S3/ADLS remote tables)
 and quality of life improvements (tables lazy loading, quoted SQL identifiers).
@@ -106,7 +130,8 @@ Initial release of `laketower`.
     - View a given table with simple query builder
     - Query all registered tables with DuckDB SQL dialect
 
-[Unreleased]: https://github.com/datalpia/laketower/compare/0.6.0...HEAD
+[Unreleased]: https://github.com/datalpia/laketower/compare/0.6.1...HEAD
+[0.6.1]: https://github.com/datalpia/laketower/compare/0.6.0...0.6.1
 [0.6.0]: https://github.com/datalpia/laketower/compare/0.5.1...0.6.0
 [0.5.1]: https://github.com/datalpia/laketower/compare/0.5.0...0.5.1
 [0.5.0]: https://github.com/datalpia/laketower/compare/0.4.1...0.5.0

{laketower-0.6.0 → laketower-0.6.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: laketower
-Version: 0.6.0
+Version: 0.6.1
 Summary: Oversee your lakehouse
 Project-URL: Repository, https://github.com/datalpia/laketower
 Project-URL: Issues, https://github.com/datalpia/laketower/issues
@@ -22,10 +22,12 @@ Classifier: Topic :: Database
 Classifier: Topic :: Software Development
 Classifier: Topic :: Utilities
 Requires-Python: <3.14,>=3.10
+Requires-Dist: bleach
 Requires-Dist: deltalake<2,>=1
 Requires-Dist: duckdb
 Requires-Dist: fastapi
 Requires-Dist: jinja2!=3.1.5,>=3
+Requires-Dist: markdown
 Requires-Dist: pandas
 Requires-Dist: pyarrow!=19.0.0
 Requires-Dist: pydantic-settings>=2
@@ -98,6 +100,10 @@ tables:
 queries:
   - name: <query_name>
     title: <Query name>
+    description: <Query description>
+    parameters:
+      <param_name_1>:
+        default: <default_value>
     sql: <sql expression>
 ```
 
@@ -527,6 +533,20 @@ $ laketower -c demo/laketower.yml tables query "select date_trunc('day', time) a
 └───────────────────────────┴────────────────────┘
 ```
 
+Use named parameters within a giving query (note: escape `$` prefixes properly!):
+
+```bash
+$ laketower -c demo/laketower.yml tables query "select date_trunc('day', time) as day, avg(temperature_2m) as mean_temperature from weather where day between \$start_date and \$end_date group by day order by day desc" -p start_date 2025-01-29 -p end_date 2025-01-31
+
+┏━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━┓
+┃ day                       ┃ mean_temperature   ┃
+┡━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━┩
+│ 2025-01-31 00:00:00+01:00 │ 5.683333257834117  │
+│ 2025-01-30 00:00:00+01:00 │ 8.900000015894571  │
+│ 2025-01-29 00:00:00+01:00 │ 7.770833313465118  │
+└───────────────────────────┴────────────────────┘
+```
+
 Export query results to CSV:
 
 ```bash
@@ -574,6 +594,22 @@ $ laketower -c demo/laketower.yml queries view daily_avg_temperature
 └───────────────────────────┴─────────────────┘
 ```
 
+Executing a predefined query with parameters (here `start_date` and `end_date`):
+
+```bash
+$ laketower -c demo/laketower.yml queries view daily_avg_temperature_params -p start_date 2025-02-01 -p end_date 2025-02-05
+
+┏━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━┓
+┃ day                       ┃ avg_temperature ┃
+┡━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━┩
+│ 2025-02-01 00:00:00+01:00 │ 4.0             │
+│ 2025-02-02 00:00:00+01:00 │ 4.0             │
+│ 2025-02-03 00:00:00+01:00 │ 4.0             │
+│ 2025-02-04 00:00:00+01:00 │ 3.0             │
+│ 2025-02-05 00:00:00+01:00 │ 3.0             │
+└───────────────────────────┴─────────────────┘
+```
+
 ## License
 
 Licensed under [Apache License 2.0](LICENSE)

{laketower-0.6.0 → laketower-0.6.1}/README.md

@@ -59,6 +59,10 @@ tables:
 queries:
   - name: <query_name>
     title: <Query name>
+    description: <Query description>
+    parameters:
+      <param_name_1>:
+        default: <default_value>
     sql: <sql expression>
 ```
 
@@ -488,6 +492,20 @@ $ laketower -c demo/laketower.yml tables query "select date_trunc('day', time) a
 └───────────────────────────┴────────────────────┘
 ```
 
+Use named parameters within a giving query (note: escape `$` prefixes properly!):
+
+```bash
+$ laketower -c demo/laketower.yml tables query "select date_trunc('day', time) as day, avg(temperature_2m) as mean_temperature from weather where day between \$start_date and \$end_date group by day order by day desc" -p start_date 2025-01-29 -p end_date 2025-01-31
+
+┏━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━┓
+┃ day                       ┃ mean_temperature   ┃
+┡━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━┩
+│ 2025-01-31 00:00:00+01:00 │ 5.683333257834117  │
+│ 2025-01-30 00:00:00+01:00 │ 8.900000015894571  │
+│ 2025-01-29 00:00:00+01:00 │ 7.770833313465118  │
+└───────────────────────────┴────────────────────┘
+```
+
 Export query results to CSV:
 
 ```bash
@@ -535,6 +553,22 @@ $ laketower -c demo/laketower.yml queries view daily_avg_temperature
 └───────────────────────────┴─────────────────┘
 ```
 
+Executing a predefined query with parameters (here `start_date` and `end_date`):
+
+```bash
+$ laketower -c demo/laketower.yml queries view daily_avg_temperature_params -p start_date 2025-02-01 -p end_date 2025-02-05
+
+┏━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━┓
+┃ day                       ┃ avg_temperature ┃
+┡━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━┩
+│ 2025-02-01 00:00:00+01:00 │ 4.0             │
+│ 2025-02-02 00:00:00+01:00 │ 4.0             │
+│ 2025-02-03 00:00:00+01:00 │ 4.0             │
+│ 2025-02-04 00:00:00+01:00 │ 3.0             │
+│ 2025-02-05 00:00:00+01:00 │ 3.0             │
+└───────────────────────────┴─────────────────┘
+```
+
 ## License
 
 Licensed under [Apache License 2.0](LICENSE)

laketower-0.6.1/demo/laketower.yml

@@ -0,0 +1,56 @@
+tables:
+  - name: sample_table
+    uri: demo/sample_table
+    format: delta
+  - name: weather
+    uri: demo/weather
+    format: delta
+  - name: invalid_uri_table
+    uri: demo/invalid_uri_table
+    format: delta
+
+queries:
+  - name: all_data
+    title: All data
+    description: Display all rows from `sample_table` and `weather` tables
+    sql: |
+      select
+        sample_table.*,
+        weather.*
+      from
+        sample_table,
+        weather
+      limit 10
+  - name: daily_avg_temperature
+    title: Daily average temperature
+    description: Display daily average temperature values from `weather` table
+    sql: |
+      select
+        date_trunc('day', time) as day,
+        round(avg(temperature_2m)) as avg_temperature
+      from
+        weather
+      group by
+        day
+      order by
+        day asc
+  - name: daily_avg_temperature_params
+    title: Daily average temperature with parameters
+    description: Display daily average temperature values from `weather` table, with dynamic filters for start and end dates
+    parameters:
+      start_date:
+        default: "2025-01-15"
+      end_date:
+        default: "2025-01-31"
+    sql: |
+      select
+        date_trunc('day', time) as day,
+        round(avg(temperature_2m)) as avg_temperature
+      from
+        weather
+      where
+        day between $start_date and $end_date
+      group by
+        day
+      order by
+        day asc

laketower-0.6.1/laketower/__about__.py

@@ -0,0 +1 @@
+__version__ = "0.6.1"

{laketower-0.6.0 → laketower-0.6.1}/laketower/cli.py

@@ -15,6 +15,7 @@ from laketower.tables import (
     ImportFileFormatEnum,
     ImportModeEnum,
     execute_query,
+    extract_query_parameter_names,
     generate_table_query,
     generate_table_statistics_query,
     import_file_to_table,
@@ -180,13 +181,21 @@ def view_table(
 
 
 def query_table(
-    config_path: Path, sql_query: str, output_path: Path | None = None
+    config_path: Path,
+    sql_query: str,
+    sql_params: list[list[str]] = [],
+    output_path: Path | None = None,
 ) -> None:
     out: rich.jupyter.JupyterMixin
     try:
         config = load_yaml_config(config_path)
         tables_dataset = load_datasets(config.tables)
-        results = execute_query(tables_dataset, sql_query)
+        sql_params_dict = {param[0]: param[1] for param in sql_params}
+        query_param_names = extract_query_parameter_names(sql_query)
+        query_params = {
+            name: sql_params_dict.get(name) or "" for name in query_param_names
+        }
+        results = execute_query(tables_dataset, sql_query, sql_params=query_params)
 
         out = rich.table.Table()
         for column in results.columns:
@@ -243,14 +252,23 @@ def list_queries(config_path: Path) -> None:
     console.print(tree)
 
 
-def view_query(config_path: Path, query_name: str) -> None:
+def view_query(
+    config_path: Path, query_name: str, query_params: list[list[str]] = []
+) -> None:
     out: rich.jupyter.JupyterMixin
     try:
         config = load_yaml_config(config_path)
         tables_dataset = load_datasets(config.tables)
         query_config = next(filter(lambda x: x.name == query_name, config.queries))
+        default_parameters = {k: v.default for k, v in query_config.parameters.items()}
         sql_query = query_config.sql
-        results = execute_query(tables_dataset, sql_query)
+        query_params_dict = {param[0]: param[1] for param in query_params}
+        sql_param_names = extract_query_parameter_names(sql_query)
+        sql_params = {
+            name: query_params_dict.get(name) or default_parameters.get(name) or ""
+            for name in sql_param_names
+        }
+        results = execute_query(tables_dataset, sql_query, sql_params=sql_params)
 
         out = rich.table.Table()
         for column in results.columns:
@@ -369,9 +387,17 @@ def cli() -> None:
     parser_tables_query.add_argument(
         "--output", help="Output query results to a file (default format: CSV)"
     )
+    parser_tables_query.add_argument(
+        "--param",
+        "-p",
+        nargs=2,
+        action="append",
+        default=[],
+        help="Inject query named parameters values",
+    )
     parser_tables_query.add_argument("sql", help="SQL query to execute")
     parser_tables_query.set_defaults(
-        func=lambda x: query_table(x.config, x.sql, x.output)
+        func=lambda x: query_table(x.config, x.sql, x.param, x.output)
     )
 
     parser_tables_import = subsparsers_tables.add_parser(
@@ -419,7 +445,17 @@ def cli() -> None:
         "view", help="View a given query"
     )
     parser_queries_view.add_argument("query", help="Name of the query")
-    parser_queries_view.set_defaults(func=lambda x: view_query(x.config, x.query))
+    parser_queries_view.add_argument(
+        "--param",
+        "-p",
+        nargs=2,
+        action="append",
+        default=[],
+        help="Inject query named parameters values",
+    )
+    parser_queries_view.set_defaults(
+        func=lambda x: view_query(x.config, x.query, x.param)
+    )
 
     args = parser.parse_args()
     args.func(args)

{laketower-0.6.0 → laketower-0.6.1}/laketower/config.py

@@ -96,9 +96,15 @@ class ConfigTable(pydantic.BaseModel):
     connection: ConfigTableConnection | None = None
 
 
+class ConfigQueryParameter(pydantic.BaseModel):
+    default: str
+
+
 class ConfigQuery(pydantic.BaseModel):
     name: str
     title: str
+    description: str | None = None
+    parameters: dict[str, ConfigQueryParameter] = {}
     sql: str