Switch Automation library for Python

This is a package for helping with the creation of Platform Guides in the Switch Automation software platform.

You can find out more about the platform on Switch Automation

Getting started

Prerequisites

• Python 3.8 or later is required to use this package.
• You must have a Switch Automation user account to use this package.

Enable Venv

Enabling virtual environment will allow us to isolate libraries per project. Allowing us to run multiple projects with different library requirements on the same system.

python -m venv pyenv

Activate the pyenv on your terminal

Windows:

./pyenv/Scripts/activate

Linux/MacOS:

. pyenv/Scripts/activate

Install the package

Install the Switch Guides library for Python with pip:

pip install switch-guides-scaffolder

Create a Guide

Follow the prompts after running the following to create a new Switch Guide with a sample step that is ready to use.

switchguides create

History

0.1.7

• Including jinja2 templates.

0.1.6

Fixed

• Include missing template files

0.1.4

Add initial Task Insights module

0.1.3

Updated

Output directory is now created automatically if it doesn't exist

0.1.2

Initial Switch Guides Scaffolder Release