laketower 0.6.0__py3-none-any.whl → 0.6.2__py3-none-any.whl

laketower/web.py

@@ -1,19 +1,24 @@
 import urllib.parse
+from dataclasses import dataclass
 from pathlib import Path
 from typing import Annotated
 
+import bleach
+import markdown
 import pydantic_settings
 from fastapi import APIRouter, FastAPI, File, Form, Query, Request, UploadFile
-from fastapi.responses import HTMLResponse, Response
+from fastapi.responses import HTMLResponse, RedirectResponse, Response
 from fastapi.staticfiles import StaticFiles
 from fastapi.templating import Jinja2Templates
 
+from laketower import __about__
 from laketower.config import Config, load_yaml_config
 from laketower.tables import (
     DEFAULT_LIMIT,
     ImportFileFormatEnum,
     ImportModeEnum,
     execute_query,
+    extract_query_parameter_names,
     generate_table_statistics_query,
     generate_table_query,
     import_file_to_table,
@@ -26,6 +31,12 @@ class Settings(pydantic_settings.BaseSettings):
     laketower_config_path: Path
 
 
+@dataclass(frozen=True)
+class AppMetadata:
+    app_name: str
+    app_version: str
+
+
 def current_path_with_args(request: Request, args: list[tuple[str, str]]) -> str:
     keys_to_update = set(arg[0] for arg in args)
     query_params = request.query_params.multi_items()
@@ -37,19 +48,28 @@ def current_path_with_args(request: Request, args: list[tuple[str, str]]) -> str
     return f"{request.url.path}?{query_string}"
 
 
+def render_markdown(md_text: str) -> str:
+    return bleach.clean(
+        markdown.markdown(md_text), tags=bleach.sanitizer.ALLOWED_TAGS | {"p"}
+    )
+
+
 templates = Jinja2Templates(directory=Path(__file__).parent / "templates")
 templates.env.filters["current_path_with_args"] = current_path_with_args
+templates.env.filters["render_markdown"] = render_markdown
 
 router = APIRouter()
 
 
 @router.get("/", response_class=HTMLResponse)
 def index(request: Request) -> HTMLResponse:
+    app_metadata: AppMetadata = request.app.state.app_metadata
     config: Config = request.app.state.config
     return templates.TemplateResponse(
         request=request,
         name="index.html",
         context={
+            "app_metadata": app_metadata,
             "tables": config.tables,
             "queries": config.queries,
         },
@@ -58,11 +78,20 @@ def index(request: Request) -> HTMLResponse:
 
 @router.get("/tables/query", response_class=HTMLResponse)
 def get_tables_query(request: Request, sql: str) -> HTMLResponse:
+    app_metadata: AppMetadata = request.app.state.app_metadata
     config: Config = request.app.state.config
     tables_dataset = load_datasets(config.tables)
+    sql_schema = {
+        table_name: dataset.schema.names
+        for table_name, dataset in tables_dataset.items()
+    }
+    sql_param_names = extract_query_parameter_names(sql)
+    sql_params = {
+        name: request.query_params.get(name) or "" for name in sql_param_names
+    }
 
     try:
-        results = execute_query(tables_dataset, sql)
+        results = execute_query(tables_dataset, sql, sql_params=sql_params)
         error = None
     except ValueError as e:
         error = {"message": str(e)}
@@ -72,10 +101,13 @@ def get_tables_query(request: Request, sql: str) -> HTMLResponse:
         request=request,
         name="tables/query.html",
         context={
+            "app_metadata": app_metadata,
             "tables": config.tables,
             "queries": config.queries,
             "table_results": results,
             "sql_query": sql,
+            "sql_schema": sql_schema,
+            "sql_params": sql_params,
             "error": error,
         },
     )
@@ -98,6 +130,7 @@ def export_tables_query_csv(request: Request, sql: str) -> Response:
 
 @router.get("/tables/{table_id}", response_class=HTMLResponse)
 def get_table_index(request: Request, table_id: str) -> HTMLResponse:
+    app_metadata: AppMetadata = request.app.state.app_metadata
     config: Config = request.app.state.config
     table_config = next(
         filter(lambda table_config: table_config.name == table_id, config.tables)
@@ -116,6 +149,7 @@ def get_table_index(request: Request, table_id: str) -> HTMLResponse:
         request=request,
         name="tables/index.html",
         context={
+            "app_metadata": app_metadata,
             "tables": config.tables,
             "queries": config.queries,
             "table_id": table_id,
@@ -128,6 +162,7 @@ def get_table_index(request: Request, table_id: str) -> HTMLResponse:
 
 @router.get("/tables/{table_id}/history", response_class=HTMLResponse)
 def get_table_history(request: Request, table_id: str) -> HTMLResponse:
+    app_metadata: AppMetadata = request.app.state.app_metadata
     config: Config = request.app.state.config
     table_config = next(
         filter(lambda table_config: table_config.name == table_id, config.tables)
@@ -144,6 +179,7 @@ def get_table_history(request: Request, table_id: str) -> HTMLResponse:
         request=request,
         name="tables/history.html",
         context={
+            "app_metadata": app_metadata,
             "tables": config.tables,
             "queries": config.queries,
             "table_id": table_id,
@@ -159,6 +195,7 @@ def get_table_statistics(
     table_id: str,
     version: int | None = None,
 ) -> HTMLResponse:
+    app_metadata: AppMetadata = request.app.state.app_metadata
     config: Config = request.app.state.config
     table_config = next(
         filter(lambda table_config: table_config.name == table_id, config.tables)
@@ -180,6 +217,7 @@ def get_table_statistics(
         request=request,
         name="tables/statistics.html",
         context={
+            "app_metadata": app_metadata,
             "tables": config.tables,
             "queries": config.queries,
             "table_id": table_id,
@@ -200,6 +238,7 @@ def get_table_view(
     sort_desc: str | None = None,
     version: int | None = None,
 ) -> HTMLResponse:
+    app_metadata: AppMetadata = request.app.state.app_metadata
     config: Config = request.app.state.config
     table_config = next(
         filter(lambda table_config: table_config.name == table_id, config.tables)
@@ -224,6 +263,7 @@ def get_table_view(
         request=request,
         name="tables/view.html",
         context={
+            "app_metadata": app_metadata,
             "tables": config.tables,
             "queries": config.queries,
             "table_id": table_id,
@@ -241,6 +281,7 @@ def get_table_import(
     request: Request,
     table_id: str,
 ) -> HTMLResponse:
+    app_metadata: AppMetadata = request.app.state.app_metadata
     config: Config = request.app.state.config
     table_config = next(
         filter(lambda table_config: table_config.name == table_id, config.tables)
@@ -257,6 +298,7 @@ def get_table_import(
         request=request,
         name="tables/import.html",
         context={
+            "app_metadata": app_metadata,
             "tables": config.tables,
             "queries": config.queries,
             "table_id": table_id,
@@ -276,6 +318,7 @@ def post_table_import(
     delimiter: Annotated[str, Form()],
     encoding: Annotated[str, Form()],
 ) -> HTMLResponse:
+    app_metadata: AppMetadata = request.app.state.app_metadata
     config: Config = request.app.state.config
     table_config = next(
         filter(lambda table_config: table_config.name == table_id, config.tables)
@@ -298,6 +341,7 @@ def post_table_import(
         request=request,
         name="tables/import.html",
         context={
+            "app_metadata": app_metadata,
             "tables": config.tables,
             "queries": config.queries,
             "table_id": table_id,
@@ -308,15 +352,37 @@ def post_table_import(
 
 
 @router.get("/queries/{query_id}/view", response_class=HTMLResponse)
-def get_query_view(request: Request, query_id: str) -> HTMLResponse:
+def get_query_view(request: Request, query_id: str) -> Response:
+    app_metadata: AppMetadata = request.app.state.app_metadata
     config: Config = request.app.state.config
     query_config = next(
         filter(lambda query_config: query_config.name == query_id, config.queries)
     )
+
+    if (
+        len(request.query_params.keys()) == 0
+        and len(query_config.parameters.keys()) > 0
+    ):
+        default_parameters = {k: v.default for k, v in query_config.parameters.items()}
+        url = request.url_for("get_query_view", query_id=query_id)
+        query_params = urllib.parse.urlencode(default_parameters)
+        return RedirectResponse(f"{url}?{query_params}")
+
     tables_dataset = load_datasets(config.tables)
+    sql_param_names = extract_query_parameter_names(query_config.sql)
+    sql_params = {
+        name: request.query_params.get(name)
+        or (
+            query_param.default
+            if (query_param := query_config.parameters.get(name))
+            else None
+        )
+        or ""
+        for name in sql_param_names
+    }
 
     try:
-        results = execute_query(tables_dataset, query_config.sql)
+        results = execute_query(tables_dataset, query_config.sql, sql_params=sql_params)
         error = None
     except ValueError as e:
         error = {"message": str(e)}
@@ -326,10 +392,12 @@ def get_query_view(request: Request, query_id: str) -> HTMLResponse:
         request=request,
         name="queries/view.html",
         context={
+            "app_metadata": app_metadata,
             "tables": config.tables,
             "queries": config.queries,
             "query": query_config,
             "query_results": results,
+            "sql_params": sql_params,
             "error": error,
         },
     )
@@ -346,6 +414,9 @@ def create_app() -> FastAPI:
         name="static",
     )
     app.include_router(router)
+    app.state.app_metadata = AppMetadata(
+        app_name="Laketower", app_version=__about__.__version__
+    )
     app.state.config = config
 
     return app

{laketower-0.6.0.dist-info → laketower-0.6.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: laketower
-Version: 0.6.0
+Version: 0.6.2
 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.2.dist-info/RECORD

@@ -0,0 +1,31 @@
+laketower/__about__.py,sha256=jFlbxEJFS0G44LE-yXXVSwXACA1J_NyYDk5E20_2zpc,22
+laketower/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+laketower/__main__.py,sha256=czKxJKG8OfncnxWmpaOWx7b1JBwFnZNQi7wKSTncB4M,108
+laketower/cli.py,sha256=QmfgqpQQIL5pyrgmnCvLiNUNcAKW6a1vnS6qTUfYcBk,16554
+laketower/config.py,sha256=flRp9yb4DK4xQUJu5g6Mr_gSMtTyJ4_jBAb-08ROvqQ,3453
+laketower/tables.py,sha256=5SbN35LjNbxEYe_pybpb1m5joaFa1bcydtXQPSWJPUo,10732
+laketower/web.py,sha256=B77Zu2aUO3sLlaHoSSO8x8iV-BoVh2l5_Yg9bxu5l6A,13407
+laketower/static/.gitkeep,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+laketower/static/editor.bundle.js,sha256=Wa1bS0xWwKDjHKPTdXd-PX41JAGkCjd0VLBCF-SyXWk,1159343
+laketower/static/editor.js,sha256=C8saQJH68X7CtdRyBmvrQxsDJ013YWoMfWF-6hzf_5s,15870
+laketower/static/vendor/bootstrap/bootstrap.bundle.min.js,sha256=5P1JGBOIxI7FBAvT_mb1fCnI5n_NhQKzNUuW7Hq0fMc,80496
+laketower/static/vendor/bootstrap-icons/bootstrap-icons.min.css,sha256=pdY4ejLKO67E0CM2tbPtq1DJ3VGDVVdqAR6j3ZwdiE4,87008
+laketower/static/vendor/bootstrap-icons/fonts/bootstrap-icons.woff,sha256=9VUTt7WRy4SjuH_w406iTUgx1v7cIuVLkRymS1tUShU,180288
+laketower/static/vendor/bootstrap-icons/fonts/bootstrap-icons.woff2,sha256=bHVxA2ShylYEJncW9tKJl7JjGf2weM8R4LQqtm_y6mE,134044
+laketower/static/vendor/halfmoon/halfmoon.min.css,sha256=RjeFzczeuZHCyS-Gvz-kleETzBF_o84ZRHukze_yv6o,369168
+laketower/static/vendor/halfmoon/halfmoon.modern.css,sha256=DD6elX-jPmbFYPsGvzodUv2-9FHkxHlVtQi0_RJVULs,10576
+laketower/templates/_base.html,sha256=2bVTAgdvZIop76oqzOGCkCf59KA14GBRWaIkEFcwZoI,3823
+laketower/templates/index.html,sha256=dLF2Og0qgzBkvGyVRidRNzTv0u4o97ifOx1jVeig8Kg,59
+laketower/templates/queries/view.html,sha256=pOx03hTR1MNycs9YfD8yFLR3VCLFStyd6CAwqdsJEEc,2551
+laketower/templates/tables/_macros.html,sha256=sCI1TOFW0QA74oSXW87H6dNTudOs7n-FretnTPFcRh4,1174
+laketower/templates/tables/history.html,sha256=a5GBLXCiLlbWno5eR0XT5i_oMAghylUBBFOpr27NB3Q,1853
+laketower/templates/tables/import.html,sha256=bQZwRrv84tDBuf0AHJyc7L-PjW-XSoZhMHNDIo6TP4c,2604
+laketower/templates/tables/index.html,sha256=saNdQbJAjMJAzayTk4rA5Mmw_bCXvor2WpghVmoWSAI,2507
+laketower/templates/tables/query.html,sha256=GueaA2_JzqLWaopMGLoU8_axNZ1KtZKMt9Ku2ghHDCU,2602
+laketower/templates/tables/statistics.html,sha256=h6TiQtFwiRWvPqDphcRRF1rZ886FP00UbJuMHuW5l6U,1827
+laketower/templates/tables/view.html,sha256=ruiAX_S--wpodmgEbcQ-GT7BQzz-vzSCk4NpzlO3I80,3985
+laketower-0.6.2.dist-info/METADATA,sha256=Pff6860NGl-7R5k47D7yNvNIuH84QWBUT-n2PqRIK9U,27664
+laketower-0.6.2.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+laketower-0.6.2.dist-info/entry_points.txt,sha256=sJpQgRwdeZhRBudNqBTqtHPCE-uLC9YgFXJY2CTEyCk,53
+laketower-0.6.2.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+laketower-0.6.2.dist-info/RECORD,,

laketower-0.6.0.dist-info/RECORD

@@ -1,23 +0,0 @@
-laketower/__about__.py,sha256=cID1jLnC_vj48GgMN6Yb1FA3JsQ95zNmCHmRYE8TFhY,22
-laketower/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-laketower/__main__.py,sha256=czKxJKG8OfncnxWmpaOWx7b1JBwFnZNQi7wKSTncB4M,108
-laketower/cli.py,sha256=tvCr90q4jRVAoP2qzwhTLG7PUsae0QOGQwJRid3GVLc,15324
-laketower/config.py,sha256=uIQSE1MjEuA-kp0TwA0QREwPbaNGL9hLGmKWqNaA8VY,3298
-laketower/tables.py,sha256=gs4klWJkyyS7_oIDz1HKFicXAF6jbGfvzJWrDw8r-rQ,10235
-laketower/web.py,sha256=-cXg_8pUCdhU5QF6WH_3luXi545F0Et9rpSC05J63Ng,10736
-laketower/static/.gitkeep,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-laketower/templates/_base.html,sha256=S-8kjAfYBx3Btb4FwzM2qyfkGYrOBHhpvCWR32mCvOw,3729
-laketower/templates/index.html,sha256=dLF2Og0qgzBkvGyVRidRNzTv0u4o97ifOx1jVeig8Kg,59
-laketower/templates/queries/view.html,sha256=naqU3XGyVVW6Er8wQ95-DYlp38Czolvh-h5noIAWs84,1978
-laketower/templates/tables/_macros.html,sha256=sCI1TOFW0QA74oSXW87H6dNTudOs7n-FretnTPFcRh4,1174
-laketower/templates/tables/history.html,sha256=a5GBLXCiLlbWno5eR0XT5i_oMAghylUBBFOpr27NB3Q,1853
-laketower/templates/tables/import.html,sha256=bQZwRrv84tDBuf0AHJyc7L-PjW-XSoZhMHNDIo6TP4c,2604
-laketower/templates/tables/index.html,sha256=saNdQbJAjMJAzayTk4rA5Mmw_bCXvor2WpghVmoWSAI,2507
-laketower/templates/tables/query.html,sha256=ymWcqZj4TtJgUeCIMseJD0PIOqy0gf1SVzrQzN9UD5Q,1652
-laketower/templates/tables/statistics.html,sha256=h6TiQtFwiRWvPqDphcRRF1rZ886FP00UbJuMHuW5l6U,1827
-laketower/templates/tables/view.html,sha256=ruiAX_S--wpodmgEbcQ-GT7BQzz-vzSCk4NpzlO3I80,3985
-laketower-0.6.0.dist-info/METADATA,sha256=HMP4sBtBKVgvO0Ay_KIJd6que4EKaICfXLXYA9TQ12o,25496
-laketower-0.6.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-laketower-0.6.0.dist-info/entry_points.txt,sha256=sJpQgRwdeZhRBudNqBTqtHPCE-uLC9YgFXJY2CTEyCk,53
-laketower-0.6.0.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-laketower-0.6.0.dist-info/RECORD,,