update docs wip

Author: EgeKaraismailogluQC

docs/guides/features/cli.md

@@ -6,26 +6,83 @@
 The CLI requires [typer](https://typer.tiangolo.com/) to be installed. You can install it with `pip install typer` or `pixi add typer`.
 ```
 
+We continue with the supermarket data pipeline scenario from the previous guides. The two data loads have been saved as parquet files:
+
+- `previous_load.parquet` — the previous data load
+- `current_load.parquet` — the current data load
+
 ## Basic usage
 
 ```bash
-diffly left.parquet right.parquet
+diffly previous_load.parquet current_load.parquet
 ```
 
-This compares two parquet files and prints a formatted summary of the differences.
+This compares two parquet files and prints a formatted summary:
+
+```text
+┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
+┃                                     Diffly Summary                                     ┃
+┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛
+   Attention: the data frames do not match exactly, but as no primary key columns are
+   provided, the row and column matches cannot be computed.
+
+ Schemas
+ ▔▔▔▔▔▔▔
+   Schemas match exactly (column count: 10).
+
+ Rows
+ ▔▔▔▔
+   The number of rows matches exactly (row count: 12).
+```
+
+Without a primary key, `diffly` can only compare schemas and row counts. To enable row-level comparison, specify a primary key.
 
 ## Specifying a primary key
 
 To enable row-level comparison, specify one or more primary key columns:
 
 ```bash
-diffly left.parquet right.parquet --primary-key id
+diffly previous_load.parquet current_load.parquet --primary-key transaction_id
 ```
 
-For composite keys, use multiple `--primary-key` options:
+```text
+┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
+┃                                     Diffly Summary                                     ┃
+┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛
+   Primary key: transaction_id
 
-```bash
-diffly left.parquet right.parquet --primary-key id --primary-key timestamp
+ Schemas
+ ▔▔▔▔▔▔▔
+   Schemas match exactly (column count: 10).
+
+ Rows
+ ▔▔▔▔
+   Left count             Right count
+       12     (no change)     12
+
+   ┏━┯━┯━┯━┯━┓
+   ┃-│-│-│-│-┃                2  left only   (16.67%)
+   ┠─┼─┼─┼─┼─┨╌╌╌┏━┯━┯━┯━┯━┓╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╮
+   ┃ │ │ │ │ ┃ = ┃ │ │ │ │ ┃  6  equal       (60.00%)  │
+   ┠─┼─┼─┼─┼─┨╌╌╌┠─┼─┼─┼─┼─┨╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌├╴  10  joined
+   ┃ │ │ │ │ ┃ ≠ ┃ │ │ │ │ ┃  4  unequal     (40.00%)  │
+   ┗━┷━┷━┷━┷━┛╌╌╌┠─┼─┼─┼─┼─┨╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╯
+                 ┃+│+│+│+│+┃  2  right only  (16.67%)
+                 ┗━┷━┷━┷━┷━┛
+
+ Columns
+ ▔▔▔▔▔▔▔
+   ┌─────────────────┬─────────┐
+   │ discount        │  70.00% │
+   │ loyalty_card_id │  90.00% │
+   │ product         │ 100.00% │
+   │ quantity        │ 100.00% │
+   │ register_id     │ 100.00% │
+   │ store_id        │ 100.00% │
+   │ timestamp       │ 100.00% │
+   │ total           │  70.00% │
+   │ unit_price      │  70.00% │
+   └─────────────────┴─────────┘
 ```
 
 ## Options

docs/guides/features/data/current_load.csv

@@ -0,0 +1,13 @@
+transaction_id,timestamp,store_id,register_id,product,quantity,unit_price,discount,total,loyalty_card_id
+TXN-001,2024-03-01T09:01:00.000000,S1,R1,Milk,2,1.5,0.0,3.0000000001,LC-1001
+TXN-002,2024-03-01T09:15:00.000000,S1,R1,Bread,1,2.8,0.0,2.8,
+TXN-003,2024-03-01T10:02:00.000000,S1,R2,Eggs,1,3.2,0.0,3.1999999999,LC-1003
+TXN-004,2024-03-01T10:30:00.000000,S1,R2,Butter,3,1.9,0.1,5.6,LC-9999
+TXN-005,2024-03-01T11:00:00.000000,S1,R1,Cheese,1,4.5,0.0,4.5,
+TXN-006,2024-03-01T11:20:00.000000,S2,R4,Apples,4,1.5,0.2,5.8,LC-2001
+TXN-007,2024-03-01T11:45:00.000000,S2,R4,Chicken,2,10.8,1.0,20.6,LC-2002
+TXN-008,2024-03-01T12:10:00.000000,S2,R4,Rice,1,4.2,0.1,4.1,
+TXN-009,2024-03-01T13:00:00.000000,S1,R1,Yogurt,2,1.2,0.0,2.4000000001,LC-1006
+TXN-010,2024-03-01T13:30:00.000000,S1,R2,Juice,3,3.0,0.0,9.0,
+TXN-013,2024-03-01T14:00:00.000000,S1,R1,Coffee,1,6.5,0.0,6.5,LC-1008
+TXN-014,2024-03-01T14:15:00.000000,S1,R2,Bananas,5,1.2,0.0,6.0,

docs/guides/features/data/previous_load.csv

@@ -0,0 +1,13 @@
+transaction_id,timestamp,store_id,register_id,product,quantity,unit_price,discount,total,loyalty_card_id
+TXN-001,2024-03-01T09:01:00.000000,S1,R1,Milk,2,1.5,0.0,3.0,LC-1001
+TXN-002,2024-03-01T09:15:00.000000,S1,R1,Bread,1,2.8,0.0,2.8,
+TXN-003,2024-03-01T10:02:00.000000,S1,R2,Eggs,1,3.2,0.0,3.2,LC-1003
+TXN-004,2024-03-01T10:30:00.000000,S1,R2,Butter,3,1.9,0.1,5.6,LC-1004
+TXN-005,2024-03-01T11:00:00.000000,S1,R1,Cheese,1,4.5,0.0,4.5,
+TXN-006,2024-03-01T11:20:00.000000,S2,R4,Apples,4,0.75,0.0,3.0,LC-2001
+TXN-007,2024-03-01T11:45:00.000000,S2,R4,Chicken,2,5.4,0.5,10.3,LC-2002
+TXN-008,2024-03-01T12:10:00.000000,S2,R4,Rice,1,2.1,0.0,2.1,
+TXN-009,2024-03-01T13:00:00.000000,S1,R1,Yogurt,2,1.2,0.0,2.4,LC-1006
+TXN-010,2024-03-01T13:30:00.000000,S1,R2,Juice,3,3.0,0.0,9.0,
+TXN-011,2024-03-01T08:00:00.000000,S2,R3,Soap,1,2.5,0.0,2.5,LC-2004
+TXN-012,2024-03-01T08:20:00.000000,S2,R3,Pasta,2,1.8,0.0,3.6,LC-2005