airship/spyglass
Code Issues Proposed changes
spyglass/doc/source/developer_quickstart.rst
Ian H Pittwood e65715d1a1 Update Spyglass documentation 
Updates CLI commands to match current code

Fixes title formatting on README

Pins six back to 1.12.0 for OpenSUSE incompatibility

Updates package dependencies list

Change-Id: Iedf6a438fbe441315dc1124364eea38056090065
2019-11-14 20:43:01 +00:00

2.0 KiB
Raw Blame History

Developer Quickstart Guide

To run your first spyglass job, follow these steps from inside the airship-spyglass directory.

  1. Install external dependencies if not already installed.

    sudo apt install -y python3-pip
sudo apt install -y tox

  2. Install Pipenv.

    pip3 install pipenv

  3. Set up an environment with Pipenv

    pipenv install

  4. Enter the Pipenv environment.

    pipenv shell

  5. Install spyglass in the tox environment.

    pip3 install .

  6. Run spyglass on the example files to generate an intermediate document.

    mkdir intermediate
spyglass excel documents -s airship-seaworthy -d intermediate -i \
           --excel-spec spyglass/examples/excel_spec.yaml \
           --excel-file spyglass/examples/SiteDesignSpec_v0.1.xlsx \
           --site-configuration spyglass/examples/site_config.yaml \
           --template-dir spyglass/examples/templates/

  7. Run spyglass on the intermediate document to generate manifests.

    mkdir manifest_dir
spyglass mi intermediate/airship-seaworthy_intermediary.yaml \
            -m manifest_dir/ -t spyglass/examples/templates/