pulumi/sdk/python
Justin Van Patten e1c1b5e3f4
Prepare for v3.130.0 release (#17048)
Tentative changelog:

### Features

- [auto/go] Add options to automation API Workspace.Install
  [#16888](https://github.com/pulumi/pulumi/pull/16888)

- [auto/go] Add Remote Automation API support for choosing a deployment
runner pool.
  [#16991](https://github.com/pulumi/pulumi/pull/16991)

- [backend/service] Prefer PULUMI_ACCESS_TOKEN set in the environment
over the one stored in the config when they don't match
  [#16970](https://github.com/pulumi/pulumi/pull/16970)

- [engine] Allow provider to be unknown during preview
  [#16868](https://github.com/pulumi/pulumi/pull/16868)

- [programgen] Add an organization intrinsic to PCL
  [#16948](https://github.com/pulumi/pulumi/pull/16948)

- [cli/install] Add `--use-language-version-tools` flag to setup python
version using pyenv during installation
  [#16855](https://github.com/pulumi/pulumi/pull/16855)

- [cli/package] Allow `pulumi package add` to work with arbitrary schema
sources
  [#16989](https://github.com/pulumi/pulumi/pull/16989)


### Bug Fixes

- [auto] Fix panic in remote automation API
  [#16978](https://github.com/pulumi/pulumi/pull/16978)

- [cli] Show a better message when logging out with `--all`.
  [#16998](https://github.com/pulumi/pulumi/pull/16998)

- [docs] Use `ComponentResourceOptions` for components
  [#16968](https://github.com/pulumi/pulumi/pull/16968)

- [docs] Show envvars for provider nested types.
  [#16984](https://github.com/pulumi/pulumi/pull/16984)

- [sdk/go] Unmarshal pointers correctly if destination type is any
  [#16914](https://github.com/pulumi/pulumi/pull/16914)

- [sdkgen/go] Use provided ImportBasePath for parameterized SDKs
  [#17036](https://github.com/pulumi/pulumi/pull/17036)

- [sdk/nodejs] Fix type checking of `Output<Record<string, any>>`
  [#16959](https://github.com/pulumi/pulumi/pull/16959)

- [sdk/nodejs] Fix NodeJS OOM detection condition

- [sdk/nodejs] Prevent double close on OOM detection channel
  [#17043](https://github.com/pulumi/pulumi/pull/17043)

- [sdkgen/nodejs] Set minimum version of core SDK when using
parameterization
  [#17032](https://github.com/pulumi/pulumi/pull/17032)

- [sdk/python] Fix the type of `StackReference.outputs` to be `Dict[str,
any]`
  [#16956](https://github.com/pulumi/pulumi/pull/16956)


### Miscellaneous

- [cli] Warn that query is planned to be removed
  [#16963](https://github.com/pulumi/pulumi/pull/16963)

- [programgen] Improve the error message for an invalid method name
2024-08-22 22:34:23 +00:00
..
cmd Install missing python versions using pyenv during installation (#16855) 2024-08-19 15:55:54 +00:00
dist Handle extra CLI arguments passed policy packs plugins (#16402) 2024-06-17 09:10:04 +00:00
lib Prepare for v3.130.0 release (#17048) 2024-08-22 22:34:23 +00:00
scripts ci: divide and conquer integration tests by sdk and package group 2022-03-04 18:08:23 -08:00
stubs Support WhoAmI in automation api for old CLI versions 2023-03-22 13:30:08 +00:00
toolchain Install missing python versions using pyenv during installation (#16855) 2024-08-19 15:55:54 +00:00
.gitignore fix(sdk/python): Allow for duplicate output values in python programs 2022-12-07 11:59:09 -05:00
.pylintrc [sdk/python] Add support for remote transforms (#15376) 2024-03-12 13:57:21 +00:00
Makefile Fix Pyright type checking of "StackReference#outputs" (#16957) 2024-08-14 05:14:23 +00:00
README.md [sdk/python] Require Python >=3.8 (#15363) 2024-02-03 16:17:15 +00:00
mypy.ini Support deeply nested protobuf objects in python (#10284) 2022-07-29 16:17:09 +01:00
pyrightconfig.json Fix Pyright type checking of "StackReference#outputs" (#16957) 2024-08-14 05:14:23 +00:00
requirements.txt Fix Pyright type checking of "StackReference#outputs" (#16957) 2024-08-14 05:14:23 +00:00

README.md

Pulumi Python SDK

The Pulumi Python SDK (pulumi) is the core package used when writing Pulumi programs in Python. It contains everything that youll 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.