a0e0208dd1
Making this change has a couple of benefits. Firstly (and honestly the main one) is it make codegen much simpler. We just to emit a base64 string and/or other embedded byte array to the generated SDK. Currently we need emit a full `proto.Value` expression for each language, and that's not hard but it's also not trivial and means more combinations of things per test per language. Secondly it will allow providers to use more efficient encodings of their parameter than JSON if there is one. I imagine some providers might make the parameter value a protobuf message and parse that (similar to what we do for transform functions), but they can easily fallback to just treating the bytes as a JSON string if they want. The only downside to this is the value is obfuscated in the generated SDK and in the state file. Neither of those are really expected to be viewed by users, so this feels like a minor loss. |
||
---|---|---|
.. | ||
cmd | ||
dist | ||
lib | ||
scripts | ||
stubs | ||
toolchain | ||
.gitignore | ||
.pylintrc | ||
Makefile | ||
README.md | ||
mypy.ini | ||
requirements.txt |
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 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.