airship/spyglass-plugin-xls
Code Issues Proposed changes
master
spyglass-plugin-xls/doc/source/getting_started.rst
Ryan Schroder f9df9d1886 Docs update for Spyglass Excel Plugin 
Removed all tugboat refernces, added getting started guide to
explain installation and steps to run, and reformated so that
all the informantion was not in the index file.

Change-Id: I20234c1c7565794d81d25565fddb2879df460d9b
2019-12-20 11:39:10 -06:00

2.4 KiB
Raw Permalink Blame History

Getting Started

This document explains the steps to installing and setting up the Spyglass Excel plugin.

1.) Clone the Spyglass Excel plugin:

git clone https://opendev.org/airship/spyglass-plugin-xls.git

2.) Clone Spyglass:

git clone https://opendev.org/airship/spyglass.git

3.) Install required packages in Spyglass directory:

pip3 install pipenv && pipenv install

4.) Launch the pipenv from your spyglass directory:

pipenv shell

5.) Install Spyglass and the Spyglass Excel plugin into the pipenv:

pip3 install . && pip3 install ../spyglass-plugin-xls/.

6.) You can now run Spyglass commands from the pipenv.

Examples

1. Required Input (Refer to 'spyglass_plugin_xls/examples' folder to get these inputs)

  1. Excel File: SiteDesignSpec_v0.1.xlsx
  2. Excel Spec: excel_spec_upstream.yaml
  3. Site Config: 'spyglass/examples/site_config.yaml'
  4. Template_dir: 'spyglass/examples/templates'
  5. Site name: airship-seaworthy
  1. Spyglass CLI Command using an Excel File:
spyglass excel documents -i -x ../spyglass-plugin-xls/spyglass_plugin_xls/examples/SiteDesignSpec_v0.1.xlsx \
       -e ../spyglass-plugin-xls/spyglass_plugin_xls/examples/excel_spec.yaml \
       -c ../spyglass-plugin-xls/spyglass_plugin_xls/examples/site_config.yaml \
       -s airship-seaworthy -t spyglass/examples/templates/
  1. Spyglass CLI Command using a CSV File:
spyglass excel documents -i -x ../spyglass-plugin-xls/spyglass_plugin_xls/examples/Site-Information.csv \
       -e ../spyglass-plugin-xls/spyglass_plugin_xls/examples/excel_spec.yaml \
       -c ../spyglass-plugin-xls/spyglass_plugin_xls/examples/site_config.yaml \
       -s airship-seaworthy -t spyglass/examples/templates/