Skip to content

Comments

Fix documentation and package installation for CLI usage#4

Draft
Copilot wants to merge 5 commits intomainfrom
copilot/update-repo-usage-guide
Draft

Fix documentation and package installation for CLI usage#4
Copilot wants to merge 5 commits intomainfrom
copilot/update-repo-usage-guide

Conversation

Copy link

Copilot AI commented Jan 14, 2026

README referenced non-existent python cli.py commands and incorrect CLI signatures. Package entry point was misconfigured preventing outlier-x command from working after installation.

Documentation Fixes

  • Fixed all CLI invocations: outlier-x (after pip install -e .) or python -m src.main
  • Corrected command signatures to match actual implementation (e.g., validate requires --input, not --schema and --data)
  • Added missing process and report command documentation
  • Added Quick Start section with working example
  • Added data format requirements table and troubleshooting guide

Package Configuration

  • Fixed pyproject.toml entry point: outlieroutlier-x
  • Added [tool.setuptools] packages configuration for proper module discovery
  • Updated .gitignore with Python-specific patterns (was Node.js only)

Example Data

  • Created examples/sample_data.{json,csv} with valid sports betting data
  • Both formats tested with all CLI commands

Usage Example

# Quick start now works as documented
git clone https://github.com/allsxxing/outlier-x.git
cd outlier-x
python3 -m venv venv && source venv/bin/activate
pip install -e .
outlier-x process --source json --path examples/sample_data.json --dry-run
Original prompt

How do I use this repo?


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Copilot AI and others added 4 commits January 14, 2026 15:37
Co-authored-by: allsxxing <104036624+allsxxing@users.noreply.github.com>
Co-authored-by: allsxxing <104036624+allsxxing@users.noreply.github.com>
…entation

Co-authored-by: allsxxing <104036624+allsxxing@users.noreply.github.com>
Co-authored-by: allsxxing <104036624+allsxxing@users.noreply.github.com>
Copilot AI changed the title [WIP] Update repository usage instructions Fix documentation and package installation for CLI usage Jan 14, 2026
Copilot AI requested a review from allsxxing January 14, 2026 15:47
@allsxxing
Copy link
Owner

@copilot GREAT! NOW CAN YOU RUN ME THRU A TEST RUN?

Copy link
Author

Copilot AI commented Jan 14, 2026

@copilot GREAT! NOW CAN YOU RUN ME THRU A TEST RUN?

Absolutely! Here's a complete test run demonstrating all CLI functionality:

Test Run Results ✅

All commands executed successfully! Here's what was tested:

1️⃣ Full Pipeline (Recommended Start)

python -m src.main process --source json --path examples/sample_data.json --dry-run

✓ Loaded 3 records → ✓ Deduplicated → ✓ Normalized → ✓ Validated → Completed in 0.00s

2️⃣ Individual Commands

Ingest:

python -m src.main ingest --source json --path examples/sample_data.json --output raw.json

✓ 3 records ingested successfully

Normalize:

python -m src.main normalize --input raw.json --output normalized.json

✓ 3 records normalized

Validate:

python -m src.main validate --input normalized.json --output validation.txt

✓ Validation report generated

Report:

python -m src.main report --input normalized.json --output report.txt

✓ Data quality report created with completeness & uniqueness metrics

3️⃣ CSV Support

python -m src.main ingest --source csv --path examples/sample_data.csv --output from_csv.json

✓ CSV data with complex fields parsed correctly

Output Files Created

  • raw.json (749 bytes) - Raw ingested data
  • normalized.json (738 bytes) - Normalized data
  • validation.txt (1.7K) - Validation report
  • report.txt (1.7K) - Quality metrics
  • from_csv.json (783 bytes) - CSV ingested data

Quick Start (Copy & Paste)

git clone https://github.com/allsxxing/outlier-x.git
cd outlier-x
python3 -m venv venv && source venv/bin/activate
pip install -e .
python -m src.main process --source json --path examples/sample_data.json --dry-run

All commands from the README work exactly as documented! 🎉

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants