pulumi/sdk/python
Will Jones 2eaea39641
Add support for parameterized invokes in Python (#16832)
Parameterization refers to the ability for a provider to vary its schema
based on a parameter that is passed to a new `Parameterize` call on the
provider interface. The package reference that is returned may then be
used to interact with the bespoke schema/packages within.
Paramterization is key to e.g. dynamically bridging providers. In this
instance we can manage and release a single "bridge" provider that
accepts a parameter defining the upstream provider to bridge, and
returns a reference to a dynamically constructed package whose schema
reflects the upstream as needed.

This commit adds support for calling parameterized `Invoke`s from the
Python SDK. As with resources, the `get_package()` utility function is
used to retrieve the parameter we bake into the SDK, before passing this
to the engine.
2024-07-29 14:51:07 +00:00
..
cmd Changelog and go.mod updates for v3.127.0 (#16805) 2024-07-25 23:47:22 +00:00
dist Handle extra CLI arguments passed policy packs plugins (#16402) 2024-06-17 09:10:04 +00:00
lib Add support for parameterized invokes in Python (#16832) 2024-07-29 14:51:07 +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 Validate that we have Poetry >= 1.8.0 (#16683) 2024-07-18 08:14:16 +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 Use black to format lib/test (#16028) 2024-04-23 08:29:58 +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
requirements.txt Update mypy (#16030) 2024-04-22 19:53:19 +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.