PythonAppResource

Docs / Reference / TypeScript APIs / Aspire.Hosting.Python / PythonAppResource

PythonAppResource

Docs Reference TypeScript APIs Aspire.Hosting.Python PythonAppResource

Handle TypeScript

📦 Aspire.Hosting.Python v13.2.0-preview.1.26159.1

interface PythonAppResource
  extends IComputeResource,
    IContainerFilesDestinationResource,
    IResource,
    IResourceWithArgs,
    IResourceWithEndpoints,
    IResourceWithEnvironment,
    IResourceWithProbes,
    IResourceWithWaitSupport,
    IResourceWithServiceDiscovery {
  withDebugging(): PythonAppResource;
  withEntrypoint(
      entrypointType: EntrypointType,
      entrypoint: string): PythonAppResource;
  withPip(
      install?: boolean,
      installArgs?: string[]): PythonAppResource;
  withUv(
      install?: boolean,
      args?: string[]): PythonAppResource;
  withVirtualEnvironment(
      virtualEnvironmentPath: string,
      createIfNotExists?: boolean): PythonAppResource;
}

Implements

• IComputeResource
• IContainerFilesDestinationResource
• IResource
• IResourceWithArgs
• IResourceWithEndpoints
• IResourceWithEnvironment
• IResourceWithProbes
• IResourceWithWaitSupport
• IResourceWithServiceDiscovery

Search members of PythonAppResource…

method

5 members Clear filters

Methods

method withDebugging builder

Enables debugging support for a Python application

withDebugging(): PythonAppResource

Returns

PythonAppResource

method withEntrypoint builder

Configures the entrypoint for a Python application

withEntrypoint(
    entrypointType: EntrypointType,
    entrypoint: string): PythonAppResource

Parameters

entrypointType EntrypointType

entrypoint string

Returns

PythonAppResource

method withPip builder

Configures pip package installation for a Python application

withPip(
    install?: boolean,
    installArgs?: string[]): PythonAppResource

Parameters

install boolean optional = True

installArgs string[] optional

Returns

PythonAppResource

method withUv builder

Configures uv package management for a Python application

withUv(
    install?: boolean,
    args?: string[]): PythonAppResource

Parameters

install boolean optional = True

args string[] optional

Returns

PythonAppResource

method withVirtualEnvironment builder

Configures the virtual environment for a Python application

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

Parameters

virtualEnvironmentPath string

createIfNotExists boolean optional = True

Returns

PythonAppResource