airship/spyglass
Code Issues Proposed changes
master
spyglass/doc/source/developer_quickstart.rst
Ryan Schroder cddf30092b Docker image guide 
Added steps to setting up, creating, and running spyglass in Docker image

Change-Id: Ib168c12306608d19df66fc7961d1ceb28d46f5f1
2020-01-16 11:27:29 -06:00

1.5 KiB
Raw Permalink Blame History

Developer Quickstart Guide

1. Clone the Spyglass directory. (Perform the following steps from inside the spyglass directory)

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

  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-plugin-xls/spyglass_plugin_xls/examples/excel_spec.yaml \
    --excel-file ../spyglass-plugin-xls/spyglass_plugin_xls/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/