withVirtualEnvironment

1. Docs
2. /Reference
3. /Search TypeScript APIs
4. /Aspire.Hosting.Python
5. /withVirtualEnvironment

Method

📦 Aspire.Hosting.Python v13.6.0

interface PythonAppResource {
  // ... omitted for brevity
  withVirtualEnvironment(
      virtualEnvironmentPath: string,
      createIfNotExists?: boolean): PythonAppResource;
}

Signature

methodwithVirtualEnvironmentbuilder

Configures a custom virtual environment path for the Python application.

withVirtualEnvironment(
    virtualEnvironmentPath: string,
    createIfNotExists?: boolean): PythonAppResource

Parameters

virtualEnvironmentPathstring

createIfNotExistsbooleanoptional= True

Returns

PythonAppResource

Applies to

This method applies to the following types:

typePythonAppResource

typeUvicornAppResource