docs: add VSCode+uv A-to-Z beginner guide; CLI/UI and analysis improvements#13
Merged
Merged
Conversation
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.
Motivation
uvvenv creation, activation, install, Ollama setup, CLI and UI usage, and troubleshooting.pytestrunnable without manually settingPYTHONPATH.Description
BEGINNER_README.mdinto a step-by-step VSCode +uvA-to-Z guide including exact shell commands, activation steps, Ollama setup, CLI/UI flows, troubleshooting, and a completion checklist.build_promptandbuild_analysis_payload_from_csv_texttobitnet_tools/analysis.py(and importio) and refactorbuild_analysis_payloadto use the new prompt builder.bitnet_tools/cli.pyto_build_parser/main, add auisubcommand that delegates toserve, support legacy positional analyze invocation, and keep optional immediateollama runexecution via--model.bitnet_tools/__init__.py, addpythonpath = ["."]to[tool.pytest.ini_options]inpyproject.toml, and add/update tests intests/test_analysis.pyand newtests/test_cli.py.Testing
pytest -qand the suite completed successfully with5 passed.python -m bitnet_tools.cli --helpwhich printed CLI usage and exited successfully.tests/test_cli.py, expandedtests/test_analysis.py) were included in the test run and passed.Codex Task