🔵 Run and Check
Run and verify your code frequently as you work.
Step 1. Run Code
Run Python scripts for your project.
See:
Step 2. Add or Update Dependencies (as needed)
If your project needs additional packages, add them to the dependencies section in pyproject.toml.
Example: you might add matplotlib to create charts.
After updating pyproject.toml, run:
uv cache clean
uv lock --upgrade
uv sync
All commands should be run from the project root folder in the VS Code terminal.
NOTE: If uv sync completes successfully but reports that it could not hardlink files and is falling back to copying them, you may continue. This is a performance warning, not an installation failure.
Step 3. Run Checks and Tests
Run the following commands to format code, fix common issues, and run tests if available.
uv run ruff format .
uv run ruff check . --fix
uv run python -m pytest --cov=src --cov-report=term-missing
Step 4. Build Documentation
Build and preview the project documentation locally.
uv run python -m zensical build
uv run python -m zensical serve
A local URL will appear in the terminal.
Ctrl+Click the link to open the documentation or try
Press Ctrl+C in the terminal to stop the server.
Professional Reminders
- Turn on Auto Save in VS Code (File / Auto Save), or save frequently.
- Comment out code as needed to keep a working version.
- If something fails, use debugging tools, logging, or
print()to inspect values.