DJ_explain setup

[sayantikabanik]

This pull request introduces a major revamp of the user onboarding and explanation experience for the DataJourney project, focusing on making workflows more discoverable, explainable, and user-friendly. The changes add a new CLI command (explain) that provides detailed, validated explanations for each workflow, and significantly rewrite the README.md to orient new users around the design philosophy, usage, and extensibility of DataJourney. Additional improvements ensure that the CLI and package are easier to install, use, and extend.

CLI and User Experience Enhancements:

• Added a new explain command to the CLI, allowing users to get detailed explanations of workflows, filter by category, validate the workflow catalog, and list available workflows. This command is now also available as a console script (datajourney explain). [1] [2] [3] [4]
• Improved the workflow listing command for better formatting and clarity, and updated the CLI group description to reflect DataJourney's focus.

Documentation and Onboarding:

• Completely rewrote the README.md to provide a design-first introduction, clearer quickstart instructions, a detailed explanation of the design philosophy, and a breakdown of available workflows and building blocks. The new README emphasizes the explainability layer and provides visual guides and contribution tips.

Packaging and Distribution:

• Updated setup.py to include the new CLI (cli.py) as a module, register the datajourney console script, and ensure workflow metadata is included as package data, making installation and extension easier.

Task Automation:

• Added a new Pixi task (DJ_explain) to run the workflow explanation CLI, aligning automation with the new onboarding flow.

These changes together make DataJourney more accessible for new users, easier to extend for contributors, and more robust in terms of workflow discoverability and explanation.

Most important changes:

1. CLI and Workflow Explanation Improvements

• Added a new explain CLI command with options for workflow detail, category filtering, listing, and catalog validation; integrated error handling and helpful suggestions for users. (cli.py, setup.py, pixi.toml) [1] [2] [3] [4]
• Registered the CLI as a datajourney console script, making it directly accessible after installation. (setup.py)

2. Documentation Overhaul

• Rewrote the README.md to focus on the design philosophy, onboarding, workflow explanation, and extensibility, including new visual guides and clearer contribution paths. (README.md)

3. Packaging and Task Automation

• Ensured workflow metadata is included as package data and added the new DJ_explain Pixi task for running the CLI explanation tool. (setup.py, pixi.toml) [1] [2]

These updates together provide a much improved first-run experience and pave the way for easier contributions and workflow discovery.