Fix documentation and package installation for CLI usage#4
Draft
Fix documentation and package installation for CLI usage#4
Conversation
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
Owner
|
@copilot GREAT! NOW CAN YOU RUN ME THRU A TEST RUN? |
Author
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 CommandsIngest: 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 Supportpython -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
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-runAll commands from the README work exactly as documented! 🎉 |
allsxxing
approved these changes
Jan 14, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
README referenced non-existent
python cli.pycommands and incorrect CLI signatures. Package entry point was misconfigured preventingoutlier-xcommand from working after installation.Documentation Fixes
outlier-x(afterpip install -e .) orpython -m src.mainvalidaterequires--input, not--schemaand--data)processandreportcommand documentationPackage Configuration
pyproject.tomlentry point:outlier→outlier-x[tool.setuptools]packages configuration for proper module discovery.gitignorewith Python-specific patterns (was Node.js only)Example Data
examples/sample_data.{json,csv}with valid sports betting dataUsage Example
Original prompt
💡 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.