Skip to content

Commit f29ee8e

Browse files
rich-iannonerich-iannone
authored
Merge pull request #221 from posit-dev/feat-add-cli-utility
feat: add CLI utility
2 parents 35d92d0 + 6bbb878 commit f29ee8e

19 files changed

+5170
-2
lines changed

‎docs/_quarto.yml‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
project:
22
type: website
33
post-render: scripts/post-render.py
4+
resources:
5+
- "assets/**"
46

57
format:
68
html:
@@ -61,6 +63,7 @@ website:
6163
contents:
6264
- user-guide/index.qmd
6365
- user-guide/installation.qmd
66+
- user-guide/cli.qmd
6467
- section: "Validation Plan"
6568
contents:
6669
- user-guide/validation-overview.qmd

‎docs/assets/vhs/cli-cicd-workflows.gif‎

1.43 MB
Loading

‎docs/assets/vhs/cli-cicd-workflows.tape‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
# VHS tape for CI/CD integration workflows
2+
# Shows production-ready automation patterns
3+
4+
Output cli-cicd-workflows.gif
5+
6+
Set FontSize 16
7+
Set Width 1200
8+
Set Height 700
9+
Set Theme "Dracula"
10+
11+
Type "# Production CI/CD Data Validation Workflows"
12+
Enter
13+
Sleep 1s
14+
15+
Type ""
16+
Enter
17+
Type "# Pipeline Step 1: Data integrity check with exit codes"
18+
Enter
19+
Type "pb validate-simple small_table --check rows-distinct --exit-code"
20+
Enter
21+
Type "echo 'Pipeline result:' \$?"
22+
Enter
23+
Sleep 3s
24+
25+
Type ""
26+
Enter
27+
Type "# Pipeline Step 2: Critical columns validation"
28+
Enter
29+
Type "pb validate-simple small_table --check col-vals-not-null --column date_time --exit-code"
30+
Enter
31+
Type "echo 'Validation status:' \$?"
32+
Enter
33+
Sleep 3s
34+
35+
Type ""
36+
Enter
37+
Type "# Pipeline Step 3: Business rules validation"
38+
Enter
39+
Type "pb validate-simple small_table --check col-vals-gt --column a --value 0 --exit-code"
40+
Enter
41+
Type "echo 'Business rule check:' \$?"
42+
Enter
43+
Sleep 3s
44+
45+
Type ""
46+
Enter
47+
Type "# Use in GitHub Actions, GitLab CI, or any automation platform"
48+
Enter
49+
Type "echo 'Exit codes: 0 = success, 1 = validation failed'"
50+
Enter
51+
Sleep 2s

‎docs/assets/vhs/cli-complete-workflow.gif‎

2.14 MB
Loading

‎docs/assets/vhs/cli-complete-workflow.tape‎

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
# VHS tape for complete validation workflow
2+
# Shows realistic end-to-end data quality checking
3+
4+
Output cli-complete-workflow.gif
5+
6+
Set FontSize 14
7+
Set Width 1200
8+
Set Height 900
9+
Set Theme "Dracula"
10+
11+
Type "# Complete Data Quality Workflow"
12+
Enter
13+
Sleep 1s
14+
15+
Type ""
16+
Enter
17+
Type "# Step 1: Explore your data first"
18+
Enter
19+
Type "pb preview small_table"
20+
Enter
21+
Sleep 3s
22+
23+
Type ""
24+
Enter
25+
Type "# Step 2: Check for basic data integrity"
26+
Enter
27+
Type "pb validate-simple small_table --check rows-distinct"
28+
Enter
29+
Sleep 3s
30+
31+
Type ""
32+
Enter
33+
Type "# Step 3: Validate critical business columns"
34+
Enter
35+
Type "pb validate-simple small_table --check col-vals-not-null --column a --show-extract"
36+
Enter
37+
Sleep 4s
38+
39+
Type ""
40+
Enter
41+
Type "# Step 4: Check data ranges and constraints"
42+
Enter
43+
Type "pb validate-simple small_table --check col-vals-in-set --column f --set 'low,mid,high'"
44+
Enter
45+
Sleep 3s
46+
47+
Type ""
48+
Enter
49+
Type "# Step 5: Comprehensive data profiling"
50+
Enter
51+
Type "pb scan small_table"
52+
Enter
53+
Sleep 4s
54+
55+
Type ""
56+
Enter
57+
Type "echo 'Full data quality pipeline complete!'"
58+
Enter
59+
Sleep 2s

‎docs/assets/vhs/cli-data-exploration.gif‎

1020 KB
Loading

‎docs/assets/vhs/cli-data-exploration.tape‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# VHS tape for data exploration and profiling
2+
# Shows preview, missing values, and column summaries
3+
4+
Output cli-data-exploration.gif
5+
6+
Set FontSize 14
7+
Set Width 1200
8+
Set Height 800
9+
Set Theme "Dracula"
10+
11+
Type "# Data Exploration & Profiling with Pointblank CLI"
12+
Enter
13+
Sleep 1s
14+
15+
Type ""
16+
Enter
17+
Type "# 1. Quick data preview - see structure and sample rows"
18+
Enter
19+
Type "pb preview small_table"
20+
Enter
21+
Sleep 4s
22+
23+
Type ""
24+
Enter
25+
Type "# 2. Missing values analysis - identify data gaps"
26+
Enter
27+
Type "pb missing small_table"
28+
Enter
29+
Sleep 4s
30+
31+
Type ""
32+
Enter
33+
Type "# 3. Comprehensive data scan - statistical overview"
34+
Enter
35+
Type "pb scan small_table"
36+
Enter
37+
Sleep 5s
38+
39+
Type ""
40+
Enter
41+
Type "echo 'Complete data profiling in seconds - no Python required!'"
42+
Enter
43+
Sleep 2s

‎docs/assets/vhs/cli-essential-validations.gif‎

941 KB
Loading

‎docs/assets/vhs/cli-essential-validations.tape‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# VHS tape for high-impact data validation demonstrations
2+
# Shows the most practical CLI validations
3+
4+
Output cli-essential-validations.gif
5+
6+
Set FontSize 16
7+
Set Width 1200
8+
Set Height 700
9+
Set Theme "Dracula"
10+
11+
Type "# Essential Data Validation with Pointblank CLI"
12+
Enter
13+
Sleep 1s
14+
15+
Type ""
16+
Enter
17+
Type "# 1. Check for duplicate rows (most common data quality issue)"
18+
Enter
19+
Type "pb validate-simple small_table --check rows-distinct"
20+
Enter
21+
Sleep 4s
22+
23+
Type ""
24+
Enter
25+
Type "# 2. Find missing values in critical columns"
26+
Enter
27+
Type "pb validate-simple small_table --check col-vals-not-null --column a"
28+
Enter
29+
Sleep 4s
30+
31+
Type ""
32+
Enter
33+
Type "# 3. When validation fails, see exactly which rows are problematic"
34+
Enter
35+
Type "pb validate-simple small_table --check col-vals-not-null --column b --show-extract"
36+
Enter
37+
Sleep 5s
38+
39+
Type ""
40+
Enter
41+
Type "echo 'Essential validations: duplicates, nulls, with data extracts'"
42+
Enter
43+
Sleep 2s

‎docs/assets/vhs/cli-getting-started.gif‎

1.14 MB
Loading

0 commit comments

Comments
 (0)