duckrun 0.1.0__py3-none-any.whl → 0.1.1__py3-none-any.whl

duckrun-0.1.1.dist-info/METADATA

@@ -0,0 +1,183 @@
+Metadata-Version: 2.4
+Name: duckrun
+Version: 0.1.1
+Summary: Lakehouse task runner powered by DuckDB for Microsoft Fabric
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/djouallah/duckrun
+Project-URL: Repository, https://github.com/djouallah/duckrun
+Project-URL: Issues, https://github.com/djouallah/duckrun/issues
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: duckdb>=1.2.0
+Requires-Dist: deltalake>=0.18.2
+Requires-Dist: requests>=2.28.0
+Dynamic: license-file
+
+# 🦆 Duckrun
+
+Simple  task runner for Microsoft Fabric Python notebook, powered by DuckDB and Delta_rs.
+
+## Installation
+
+```bash
+pip install duckrun
+```
+
+
+
+## Quick Start
+
+```python
+import duckrun as dr
+
+# Connect to your Fabric lakehouse
+lakehouse = dr.connect(
+    workspace="my_workspace",
+    lakehouse_name="my_lakehouse", 
+    schema="dbo",
+    sql_folder="./sql"  # folder containing your .sql and .py files
+)
+
+# Define your pipeline
+pipeline = [
+    ('load_data', (url, path)),           # Python task
+    ('clean_data', 'overwrite'),          # SQL task  
+    ('aggregate', 'append')               # SQL task
+]
+
+# Run it
+lakehouse.run(pipeline)
+```
+
+## How It Works
+
+Duckrun runs two types of tasks:
+
+### 1. Python Tasks
+Format: `('function_name', (arg1, arg2, ...))`
+
+Create a file `sql_folder/function_name.py` with a function matching the name:
+
+```python
+# sql_folder/load_data.py
+def load_data(url, path):
+    # your code here
+    # IMPORTANT: Must return 1 for success, 0 for failure
+    return 1
+```
+
+### 2. SQL Tasks  
+Format: `('table_name', 'mode')` or `('table_name', 'mode', {params})`
+
+Create a file `sql_folder/table_name.sql`:
+
+```sql
+-- sql_folder/clean_data.sql
+SELECT 
+    id,
+    TRIM(name) as name,
+    date
+FROM raw_data
+WHERE date >= '2024-01-01'
+```
+
+**Modes:**
+- `overwrite` - Replace table completely
+- `append` - Add to existing table
+- `ignore` - Create only if doesn't exist
+
+## Task Files
+
+The `sql_folder` can contain a mixture of both `.sql` and `.py` files. This allows you to combine SQL transformations and Python logic in your pipelines.
+
+### SQL Files
+Your SQL files automatically have access to:
+- `$ws` - workspace name
+- `$lh` - lakehouse name
+- `$schema` - schema name
+
+Pass custom parameters:
+
+```python
+pipeline = [
+    ('sales', 'append', {'start_date': '2024-01-01', 'end_date': '2024-12-31'})
+]
+```
+
+```sql
+-- sql_folder/sales.sql
+SELECT * FROM transactions
+WHERE date BETWEEN '$start_date' AND '$end_date'
+```
+
+## Table Name Convention
+
+Use `__` to create variants of the same table:
+
+```python
+pipeline = [
+    ('sales__initial', 'overwrite', {}),    # writes to 'sales' table
+    ('sales__incremental', 'append', {}),   # appends to 'sales' table
+]
+```
+
+Both write to the same `sales` table, but use different SQL files.
+
+## Query Data
+
+```python
+# Run queries
+lakehouse.sql("SELECT * FROM my_table LIMIT 10").show()
+
+# Get as DataFrame
+df = lakehouse.sql("SELECT COUNT(*) FROM sales").df()
+```
+
+## Real-World Example
+
+```python
+import duckrun as dr
+
+lakehouse = dr.connect(
+    workspace="Analytics",
+    lakehouse_name="Sales", 
+    schema="dbo",
+    sql_folder="./etl"
+)
+
+# Daily pipeline
+daily = [
+    ('download_files', (api_url, local_path)),
+    ('staging_orders', 'overwrite', {'run_date': '2024-06-01'}),
+    ('staging_customers', 'overwrite', {'run_date': '2024-06-01'}),
+    ('fact_sales', 'append'),
+    ('dim_customer', 'overwrite')
+]
+
+lakehouse.run(daily)
+
+# Check results
+lakehouse.sql("SELECT COUNT(*) FROM fact_sales").show()
+```
+
+## Remote SQL Files
+
+You can load SQL/Python files from a URL:
+
+```python
+lakehouse = dr.connect(
+    workspace="Analytics",
+    lakehouse_name="Sales", 
+    schema="dbo",
+    sql_folder="https://raw.githubusercontent.com/user/repo/main/sql"
+)
+```
+
+## Real-Life Usage
+
+For a complete, production-style example, see [fabric_demo](https://github.com/djouallah/fabric_demo).
+
+## License
+
+MIT

duckrun-0.1.1.dist-info/RECORD

@@ -0,0 +1,7 @@
+duckrun/__init__.py,sha256=L0jRtD9Ld8Ti4e6GRvPDdHvkQCFAPHM43GSP7ARh6EM,241
+duckrun/core.py,sha256=-Vf2nYwhdsVpTZS9mGBtm8j_HNAcHR7Cj075pida3Yw,13133
+duckrun-0.1.1.dist-info/licenses/LICENSE,sha256=-DeQQwdbCbkB4507ZF3QbocysB-EIjDtaLexvqRkGZc,1083
+duckrun-0.1.1.dist-info/METADATA,sha256=4KZAURlPgjIDGYW_htE4gdHLi6WX-3gpfrCY0r1sFPE,4114
+duckrun-0.1.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+duckrun-0.1.1.dist-info/top_level.txt,sha256=BknMEwebbUHrVAp3SC92ps8MPhK7XSYsaogTvi_DmEU,8
+duckrun-0.1.1.dist-info/RECORD,,

duckrun-0.1.1.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Mimoune
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

duckrun-0.1.0.dist-info/METADATA

@@ -1,11 +0,0 @@
-Metadata-Version: 2.4
-Name: duckrun
-Version: 0.1.0
-Summary: Lakehouse task runner powered by DuckDB for Microsoft Fabric
-License-Expression: MIT
-Project-URL: Homepage, https://github.com/djouallah/duckrun
-Project-URL: Repository, https://github.com/djouallah/duckrun
-Project-URL: Issues, https://github.com/djouallah/duckrun/issues
-Requires-Python: >=3.9
-License-File: LICENSE
-Dynamic: license-file

duckrun-0.1.0.dist-info/RECORD

@@ -1,7 +0,0 @@
-duckrun/__init__.py,sha256=L0jRtD9Ld8Ti4e6GRvPDdHvkQCFAPHM43GSP7ARh6EM,241
-duckrun/core.py,sha256=-Vf2nYwhdsVpTZS9mGBtm8j_HNAcHR7Cj075pida3Yw,13133
-duckrun-0.1.0.dist-info/licenses/LICENSE,sha256=b0pMNsWFx7PvXXtQo-XLqFnPRirAtdWBWwQp39phnWI,20
-duckrun-0.1.0.dist-info/METADATA,sha256=U6-bDm1EQx47ELIzUfFXYwcalUU9ZxfBsDleowie9L4,410
-duckrun-0.1.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-duckrun-0.1.0.dist-info/top_level.txt,sha256=BknMEwebbUHrVAp3SC92ps8MPhK7XSYsaogTvi_DmEU,8
-duckrun-0.1.0.dist-info/RECORD,,

duckrun-0.1.0.dist-info/licenses/LICENSE

@@ -1 +0,0 @@
-### **5. `LICENSE`**