airship/spyglass
Code Issues Proposed changes
spyglass/doc/source/developer_quickstart.rst
Ryan Schroder 161528365d Spyglass Docs Update 
Changed paths for all examples, removed references to Tugboat
and Formation

Change-Id: Ibeb80a1c239169bd4f4ecb124e86671891bef99a
2019-12-16 17:01:00 +00:00

2.2 KiB
Raw 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/