pulumi/sdk/python
Justin Van Patten fd2b278114
Prepare for v3.143.0 release (#18011)
Tentative changelog:

### Features

- [cli] Autonaming configuration in experimental mode
  [#17916](https://github.com/pulumi/pulumi/pull/17916)

- [cli] Suggest `state repair` as part of integrity panics
  [#17919](https://github.com/pulumi/pulumi/pull/17919)

- [engine] Add PULUMI_DEBUG_LANGUAGES much like PULUMI_DEBUG_PROVIDERS
so we can attach debuggers to languages easily
  [#17821](https://github.com/pulumi/pulumi/pull/17821)

- [engine] Warn if `refresh` or `destroy` use older plugins

- [protobuf] Add `Handshake` to the provider protocol
  [#17819](https://github.com/pulumi/pulumi/pull/17819)

- [sdk/dotnet] Upgrade pulumi-dotnet to 3.71.0
  [#17937](https://github.com/pulumi/pulumi/pull/17937)

- [programgen/{dotnet,nodejs,python}] Emit deferred outputs for mutually
dependant components
  [#17859](https://github.com/pulumi/pulumi/pull/17859)

- [sdk/go] Allow specifying dependencies for output invokes. Go code
generation for Output form invokes will use the new
`Context.InvokeOutput` method.
  [#17791](https://github.com/pulumi/pulumi/pull/17791)

- [sdk/nodejs] Add getSchema to Provider interface
  [#17950](https://github.com/pulumi/pulumi/pull/17950)

- [sdk/{nodejs,python}] Update Python and NodeJS to use the new
GetRequiredPackage functionality
  [#17910](https://github.com/pulumi/pulumi/pull/17910)

- [cli/package] Automatically set up package dependencies when adding a
package when possible
  [#17815](https://github.com/pulumi/pulumi/pull/17815)

- [sdk/python] Drop Python 3.8 support
  [#17883](https://github.com/pulumi/pulumi/pull/17883)


### Bug Fixes

- [backend/diy] Show a more correct URL for lock files in error messages
  [#17961](https://github.com/pulumi/pulumi/pull/17961)

- [sdk/go] Inherit `protect` from `parent`s in the Go SDK
  [#17936](https://github.com/pulumi/pulumi/pull/17936)

- [sdk/go] Fix a `defer` leak when writing memory profiles
  [#17581](https://github.com/pulumi/pulumi/pull/17581)

- [sdkgen/go] Fix writing of go.mod files for parameterized packages
  [#17923](https://github.com/pulumi/pulumi/pull/17923)

- [auto/{go,nodejs,python}] Expose `whoami` token information in
automation API types
  [#17735](https://github.com/pulumi/pulumi/pull/17735)

- [cli/install] Don't recreate virtualenvs when using venv
  [#17892](https://github.com/pulumi/pulumi/pull/17892)

- [auto/nodejs] Don't hang indefinitely on failed inputs
  [#17899](https://github.com/pulumi/pulumi/pull/17899)

- [auto/python] Catch BaseException in automation API server
  [#17909](https://github.com/pulumi/pulumi/pull/17909)

- [sdk/nodejs] Throw from `output()` on circular structures
  [#17852](https://github.com/pulumi/pulumi/pull/17852)

- [sdkgen/{nodejs,python}] Bump the minimum SDK version to 3.142.0
  [#17997](https://github.com/pulumi/pulumi/pull/17997)


### Miscellaneous

- [sdk/python] Switch to ruff for linting and formatting
  [#17882](https://github.com/pulumi/pulumi/pull/17882)

- [sdkgen] Include parameterization details in pulumi-plugin.json
  [#17867](https://github.com/pulumi/pulumi/pull/17867)
2024-12-11 18:29:42 +00:00
..
cmd Add PULUMI_DEBUG_LANGUAGES support to go, python, and nodejs. (#17821) 2024-12-11 08:50:52 +00:00
dist Handle extra CLI arguments passed policy packs plugins (#16402) 2024-06-17 09:10:04 +00:00
lib Prepare for v3.143.0 release (#18011) 2024-12-11 18:29:42 +00:00
scripts Give Node.js and Python coverage files unique names to improve code coverage quality (#17100) 2024-08-29 15:55:03 +00:00
stubs Support WhoAmI in automation api for old CLI versions 2023-03-22 13:30:08 +00:00
toolchain Don't recreate virtualenvs when using venv (#17892) 2024-12-02 16:22:31 +00:00
.gitignore fix(sdk/python): Allow for duplicate output values in python programs 2022-12-07 11:59:09 -05:00
Makefile Switch to ruff for linting and formatting (#17882) 2024-12-02 12:41:19 +00:00
README.md [sdk/python] Require Python >=3.8 (#15363) 2024-02-03 16:17:15 +00:00
mypy.ini Drop Python 3.8 support (#17883) 2024-12-02 16:13:08 +00:00
pyrightconfig.json Fix Pyright type checking of "StackReference#outputs" (#16957) 2024-08-14 05:14:23 +00:00
requirements.txt Switch to ruff for linting and formatting (#17882) 2024-12-02 12:41:19 +00:00
ruff.toml Drop Python 3.8 support (#17883) 2024-12-02 16:13:08 +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.