Aspire.Hosting.Python

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

Aspire.Hosting.Python

Docs Reference Search TypeScript APIs Aspire.Hosting.Python

Official

📦 Aspire.Hosting.Python v13.2.0

9 Functions

3 Types

Search types, functions, members in Aspire.Hosting.Python...

enum function handle method

3 types and 5 members Clear filters

Types

handle PythonAppResource 5 members

handle UvicornAppResource

Functions

function addPythonApp builder

Adds a Python script application resource

addPythonApp(name: string, appDirectory: string, scriptPath: string): PythonAppResource

function addPythonExecutable builder

Adds a Python executable application resource

addPythonExecutable(name: string, appDirectory: string, executableName: string): PythonAppResource

function addPythonModule builder

Adds a Python module application resource

addPythonModule(name: string, appDirectory: string, moduleName: string): PythonAppResource

function addUvicornApp builder

Adds a Uvicorn-based Python application resource

addUvicornApp(name: string, appDirectory: string, app: string): UvicornAppResource

function withDebugging builder

Enables debugging support for a Python application

withDebugging(): PythonAppResource

function withEntrypoint builder

Configures the entrypoint for a Python application

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

function withPip builder

Configures pip package installation for a Python application

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

function withUv builder

Configures uv package management for a Python application

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

function withVirtualEnvironment builder

Configures the virtual environment for a Python application

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

Enums

enum EntrypointType 3 values