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

Install external dependencies if not already installed.

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

Install Pipenv.
```
pip3 install pipenv
```
Set up an environment with Pipenv
```
pipenv install
```
Enter the Pipenv environment.
```
pipenv shell
```
Install spyglass in the tox environment.
```
pip3 install .
```

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/

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/