PyUcc

A brief description of PyUcc.

Features

Feature 1
Feature 2

Getting Started

...

Using a local `.venv` (recommended)

If the repository contains a local virtual environment directory named .venv the helper script tools/run_with_venv.ps1 will prefer it for installing/updating dependencies and for running the application. This avoids accidentally using a global Python environment and keeps project dependencies isolated.

Windows (PowerShell) quick commands:

# create .venv if missing and install requirements
.\tools\run_with_venv.ps1 -Install

# run the application using the .venv python
.\tools\run_with_venv.ps1 -Run -Module pyucc -- --gui

Notes:

The script will attempt to create .venv using python -m venv .venv if the folder does not exist.
It calls the venv-local python.exe directly (no need to Activate the environment in PowerShell).
On POSIX systems you can achieve the same behavior by invoking the venv's python explicitly:

python -m venv .venv      # only if you need to create the venv
.venv/bin/python -m pip install -r requirements.txt
.venv/bin/python -m pyucc --gui

Auto-activate `.venv` when opening workspace (VS Code)

If you use VS Code you can make the workspace automatically prefer and activate the local .venv:

A workspace settings file .vscode/settings.json is included that sets the Python interpreter to ${workspaceFolder}/.venv/Scripts/python.exe (Windows) and configures the integrated PowerShell terminal so it runs Activate.ps1 automatically when opened.
When you open the workspace in VS Code the selected interpreter will be the project's .venv and the default terminal will activate it automatically.

If you prefer Bash or POSIX terminals in VS Code, instead open a new terminal and run:

source .venv/bin/activate

Contributing

...

License

...

1.9 KiB Raw Permalink Blame History