Working with Python environment variables

Working with Python environment variables

1. Overview

Environment variables can be used to configure dynamic requirements within an application. And they can be used to store sensitive information like API keys, machine credentials, and encryption secrets.

In development, it's important to protect this sensitive data from being exposed in code repositories or logs. In production, security is even more critical to prevent unauthorized data leakages and breaches.

In this codelab, let's learn how to use environment variables in Python with our Viam projects so our code runs smoothly from development to deployment.

Prerequisites

What You'll Learn

What You'll Need

What You'll Build

2. Set up a machine for local development

Borrow a rover online with Try Viam

  1. Borrow a Viam rover: Let's use Try Viam to borrow a rover online at no cost which is already configured with all the components you need. If you want to use your own wheeled robot, see more details in this tutorial.
  2. Once the rover is configured, click Try Viam Now.
  3. Examine the modular resources that make up the machine in the Viam app listed in the left sidebar of the CONFIGURE and CONTROL tabs.

3. Prepare a virtual environment

Prepare a project directory

  1. Set up your project directory: From the command line in your terminal window, make a directory for your project, for example, called viam-rover. And navigate into the directory.
mkdir viam-rover
cd viam-rover

Prepare a virtual environment

Set up a Python virtual environment to avoid any conflicts with other projects or your system.

  1. From the command line in your terminal window, install virtualenv using pip
python3 -m pip install --user virtualenv
  1. Create and activate a virtual environment: In the project directory viam-rover, create and activate a virtual environment called .venv for Python to run in. 
    python3 -m venv .venv
source .venv/bin/activate
    Now, .venv prepends the commands in your terminal window to indicate the Python packages being used are from this particular environment. You can exit this environment by running deactivate.

Install the Python SDK

Install the Viam Python SDK and all required general dependencies.

  1. Install the SDK: From the command line in your terminal window (inside the activated .venv Python environment), install the Viam Python SDK:
pip install viam-sdk

4. Using variables in local development

Copy the sample code

  1. Refer to Python sample code: In the Viam app, go to the CONNECT tab, and select Python.
  2. Show secrets: The sample code shows you how to authenticate and connect to a machine, as well as some of the methods you can use on your configured components and services. To show your machine's API key and API key ID in the sample code, toggle Include secret on the CONNECT tab's Code sample page.
  3. Hide secrets: Instead of leaving our sensitive credentials hard coded in this code sample, let's set up our API key and API key ID as environment variables. Toggle Include secrets once again, this time to remove the credentials from the code sample.
  4. Create the code file: From the command line in your terminal window, create a new file called rover.py.
touch rover.py
  1. Paste the code sample: Copy and paste the code sample from the Viam app into this new file rover.py.

Run the sample code

  1. Create .env file: From the command line, create a new file called .env to store our environment variables to use in local development.
touch .env
  1. Input environment variables: Add your own environment variables to the .env file, formatted like the following. Make sure to update the values with your own environment variables from the code sample in the Viam app, placed between the double quotes as shown here.
ROBOT_API_KEY="sijdb24bjnxsmp18mij0hace6smihu0r"
ROBOT_API_KEY_ID="9e135013-f3bf-40fc-a0e3-e6fc66a418d7"
  1. Install python-dotenv package: From the command line, still within our virtual environment .venv, install the python-dotenv package to read key-value pairs from an .env file and can set them as environment variables.
pip install python-dotenv
  1. Load the variables into your environment: At the top of your rover.py file, add the following code to load variables into your environment.
from dotenv import load_dotenv
import os

load_dotenv()  # Loads the environment variables from the .env file

ROBOT_API_KEY = os.getenv('ROBOT_API_KEY')
ROBOT_API_KEY_ID = os.getenv('ROBOT_API_KEY_ID')
  1. Use variables in your code: You can now use these variables within your code. On rows 7 and 8 in rover.py, you load values from outside of your code (your environment) into python variables. And then on rows 20 and 21, you use those variables to access your machine.
  2. Run the code: Run the sample code to connect to your machine, and inspect the output.
python rover.py

In the next few sections, learn how to use variables on your machine in production.

5. Add the control code to your machine

Once you have the code working in your local development environment, you may choose to move your control code to your machine, so that it can run in production.

Add the control code to your machine

  1. SSH into your board: From the terminal window, run the following command to SSH (Secure Shell) into your board, where the text in <> should be replaced (including the < and > symbols themselves) with the user and hostname you configured when you set up your machine.
ssh <USERNAME>@<REMOTE-HOSTNAME>.local
  1. Create a project directory: Create a new directory on your machine to hold your project code.
mkdir robot
  1. Create and activate a virtual environment: In the new project directory robot, create and activate a virtual environment called .venv for Python to run in.
python3 -m venv .venv
source .venv/bin/activate

Once again, .venv prepends the commands in your terminal window to indicate the Python packages being used are from this particular environment. You can exit this environment by running deactivate.

  1. Install dependencies: Install the Viam Python SDK (and other dependencies if required) into the folder.
pip install viam-sdk
  1. Copy file(s) to the machine: From the original computer you were developing on (not the secure shell prompt accessing your machine), copy the rover.py file to your machine.
scp rover.py <USERNAME>@<REMOTE-HOSTNAME>.local:./robot/rover.py
  1. Add a process: Configure a process by going to the CONFIGURE tab of the Viam app. Click the plus icon ( +) next to your machine in the left-hand menu and select Process. Name your process process-rover.
  2. Find executable path: To find out the path of the Python 3 executable that is being used on your machine, you can input which python3 in the command line from within your secure shell. You will need this output for the upcoming steps.
  3. Find file location: To find the complete path of your rover.py file on your machine, navigate into the new robot/ directory, and input pwd in the command line from within your secure shell. You will need this output for the next step.
  4. Configure the process: Fill in the required fields to configure your process and Save in the upper right corner of the screen to save your config. The following example configuration executes the command python3 rover.py in your home/myName/robot/ directory every time your machine boots, and keeps it executing indefinitely.

In our example, we added our code as a process, but you can also add control code to your machine as a module.

6. Using environment variables on machine in production

Now that you've moved your control code to your machine, let's set up our environment variables to use in production.

Update the configuration JSON

  1. Locate the modular resource: In the Viam app under the CONFIGURE tab, select the modular resource in the side bar to locate the card where we will add environment variables. At the top right of the card, select the curly braces icon to see advanced configuration details.
  2. Add a new JSON property called env and your environment variables, formatted like the following.
  3. Save the changes at the top of the page, and restart the machine in the status dropdown at the top.

Other ways to use variables

This is the recommended approach to using Viam environment variables within a a registry module, or other modular resources on a physical device.

But there are other ways to use environment variables:

7. Next Steps

Knowing how to manage environment variables allows you to work more efficiently and keep your code DRY (Don't Repeat Yourself) for more maintainable, readable, and error free code. It's also important for security reasons not to leak sensitive data and risk access to secure systems.

What You Learned

Related Resources