python

README

Pulumi Python SDK

The Pulumi Python SDK (pulumi) is the core package used when writing Pulumi programs in Python. It contains everything that you’ll need in order to interact with Pulumi resource providers and express infrastructure using Python code. Pulumi resource providers all depend on this library and express their resources in terms of the types defined in this module.

The Pulumi Python SDK requires a supported version of Python.

note: pip is required to install dependencies. If you installed Python from source, with an installer from python.org, or via Homebrew you should already have pip. If Python is installed using your OS package manager, you may have to install pip separately, see Installing pip/setuptools/wheel with Linux Package Managers. For example, on Debian/Ubuntu you must run sudo apt install python3-venv python3-pip.

Getting Started

The fastest way to get up and running is to choose from one of the following Getting Started guides: -aws -microsoft azure -google cloud -kubernetes

Pulumi Programming Model

The Pulumi programming model defines the core concepts you will use when creating infrastructure as code programs using Pulumi. Architecture & Concepts describes these concepts with examples available in Python. These concepts are made available to you in the Pulumi SDK.

The Pulumi SDK is available to Python developers as a Pip package distributed on PyPI . To learn more, refer to the Pulumi SDK Reference Guide.

The Pulumi programming model includes a core concept of Input and Output values, which are used to track how outputs of one resource flow in as inputs to another resource. This concept is important to understand when getting started with Python and Pulumi, and the [Inputs and Outputs] (https://www.pulumi.com/docs/intro/concepts/inputs-outputs/)documentation is recommended to get a feel for how to work with this core part of Pulumi in common cases.

The Pulumi Python Resource Model

Like most languages usable with Pulumi, Pulumi represents cloud resources as classes and Python programs can instantiate those classes. All classes that can be instantiated to produce actual resources derive from the pulumi.Resource class.

Documentation

Index

• func ActivateVirtualEnv(environ []string, virtualEnvDir string) []string
• func Command(ctx context.Context, arg ...string) (*exec.Cmd, error)
• func CommandPath() (string, string, error)
• func InstallDependencies(ctx context.Context, root, venvDir string, showOutput bool) error
• func InstallDependenciesWithWriters(ctx context.Context, root, venvDir string, showOutput bool, ...) error
• func IsVirtualEnv(dir string) bool
• func NewVirtualEnvError(dir, fullPath string) error
• func VirtualEnvCommand(virtualEnvDir, name string, arg ...string) *exec.Cmd

Functions

func ActivateVirtualEnv

func ActivateVirtualEnv(environ []string, virtualEnvDir string) []string

ActivateVirtualEnv takes an array of environment variables (same format as os.Environ()) and path to a virtual environment directory, and returns a new "activated" array with the virtual environment's "bin" dir ("Scripts" on Windows) prepended to the `PATH` environment variable and `PYTHONHOME` variable removed.

func Command

func Command(ctx context.Context, arg ...string) (*exec.Cmd, error)

Command returns an *exec.Cmd for running `python`. Uses `ComandPath` internally to find the correct executable.

func CommandPath

func CommandPath() (string, string, error)

CommandPath finds the correct path and command for Python. If the `PULUMI_PYTHON_CMD` variable is set it will be looked for on `PATH`, otherwise, `python3` and `python` will be looked for.

func InstallDependencies

func InstallDependencies(ctx context.Context, root, venvDir string, showOutput bool) error

InstallDependencies will create a new virtual environment and install dependencies in the root directory.

func InstallDependenciesWithWriters

func InstallDependenciesWithWriters(ctx context.Context,
	root, venvDir string, showOutput bool, infoWriter, errorWriter io.Writer,
) error

func IsVirtualEnv

func IsVirtualEnv(dir string) bool

IsVirtualEnv returns true if the specified directory contains a python binary.

func NewVirtualEnvError

func NewVirtualEnvError(dir, fullPath string) error

NewVirtualEnvError creates an error about the virtual environment with more info on how to resolve the issue.

func VirtualEnvCommand

func VirtualEnvCommand(virtualEnvDir, name string, arg ...string) *exec.Cmd

VirtualEnvCommand returns an *exec.Cmd for running a command from the specified virtual environment directory.