Metadata-Version: 2.1
Name: switch_guides_scaffold
Version: 0.1.7
Summary: A package for helping with the creation of Platform Guides in Switch Automation Platform.
Home-page: UNKNOWN
Author: Switch Automation Pty Ltd.
License: MIT License
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: License :: OSI Approved :: MIT License
Classifier: Intended Audience :: Other Audience
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Natural Language :: English
Requires-Python: >=3.8.*
Description-Content-Type: text/markdown
License-File: LICENCE
License-File: AUTHORS.rst

# 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](https://www.switchautomation.com)

## Getting started

### Prerequisites
* Python 3.8 or later is required to use this package. 
* You must have a [Switch Automation user account](https://www.switchautomation.com/our-solution/) 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.

```bash
python -m venv pyenv
```

Activate the pyenv on your terminal

Windows:
```bash
./pyenv/Scripts/activate
```

Linux/MacOS:
```bash
. pyenv/Scripts/activate
```

### Install the package
Install the Switch Guides library for Python with [pip](https://pypi.org/project/pip/):

```bash
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.

```bash
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

