Skip to content

🔵 Run the Project Code

Run the example project exactly as provided.

Step 1. Find the Run Command

Open the project README.md. Use the exact run command shown there. For example:

shell uv run python -m datafun.app

Step 2. Run the Project

Open a VS Code terminal in the project root folder. Copy the command from the README, paste it into the terminal, and press Enter.

Step 3. Verify

The project should run from beginning to end without an unexpected error. You may see terminal output and a new project.log file.

If the terminal ran an `activate` command automatically

If your terminal ran an activate command by itself when it opened, that's expected and harmless. uv run manages the environment. We do not need to activate anything. Most example projects turn this off in the .vscode/settings.json file.

If the project does not run

First verify:

  • You opened only the project folder in VS Code.
  • Your terminal is in the project root folder.
  • You completed the Python environment setup.
  • You copied the exact command from the README.

The project root contains files such as:

text pyproject.toml README.md src/

If the environment is not ready, return to:

Set Up the Project Python Environment

Windows Smart Application Control

If Windows reports that python.exe was blocked, see:

Windows: Smart App Control Blocks python.exe

More about the Python command

For professional projects that use a src/ layout, we usually run Python code as a module:

shell uv run python -m package_name.module_name

For example:

shell uv run python -m datafun.app

  • uv run uses the project's managed environment.
  • python runs Python.
  • -m runs a Python module.
  • datafun.app identifies the package and module.

Running as a module helps Python find local imports correctly.

Success

  • [ ] The project should run and end with a line like "Executed successfully!" in the terminal.
  • [ ] You may see a new project.log file appear.
  • [ ] You may see new generated artifacts appear.

◄ Back to 🔵 Phase 1