Python

Pulumi supports programs written in Python 3. Python version 3.6 or later is required.

Install Python version 3.6 or later. To reduce potential issues with setting up your Python environment on Windows or macOS, you should install Python through the official Python installer.

Getting Started

The fastest way to get started with Pulumi Python is by using a template. From an empty directory in which you’d like to create a new project:

$ mkdir myproject && cd myproject
$ pulumi new python

This creates a Pulumi.yaml file, containing minimal metadata about your project (including a name and description, which you may wish to change), a requirements.txt file, where you will specify your dependencies (see Using Pulumi PyPI Packages below), and a __main__.py file, containing your program.

Pulumi Programming Model

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 documentation is recommended to get a feel for how to work with this core part of Pulumi in common cases.

Using Pulumi PyPI Packages

Virtual Environments

It is not required, but we recommend using a virtual environment to isolate the dependencies of your projects and ensure reproducibility between machines.

As of Pulumi 2.4.0, new Python projects created with pulumi new will have a virtual environment created in a venv directory with required dependencies from requirements.txt installed in it, and Pulumi will automatically use this virtual environment when running the program.

This behavior is controlled by the following virtualenv runtime option in Pulumi.yaml:

runtime:
  name: python
  options:
    virtualenv: venv

virtualenv is the path to a virtual environment to use.

Existing Python projects can opt-in to using the built-in virtual environment support by setting the virtualenv option. To manually create a virtual environment and install dependencies, run the following commands in your project directory:

$ python3 -m venv venv
$ venv/bin/pip install -r requirements.txt

$ python3 -m venv venv
$ venv/bin/pip install -r requirements.txt

> python -m venv venv
> venv\Scripts\pip install -r requirements.txt

If you prefer to manage the virtual environment on your own (for example, using a tool like Pipenv), you can delete the local venv directory and unset the virtualenv option in Pulumi.yaml:

runtime: python

When managing the virtual environment on your own, you’ll need to run any pulumi commands (such as pulumi up) from an activated virtual environment shell (or, if using a tool like Pipenv, prefix any pulumi commands with pipenv run pulumi ...).

Adding a new dependency

There are many Pulumi Python packages available.

To install a new dependency in the virtual environment, add an entry to requirements.txt, and run the following in your project directory:

$ venv/bin/pip install -r requirements.txt

$ venv/bin/pip install -r requirements.txt

> venv\Scripts\pip install -r requirements.txt