spyglass/doc/source/developer_quickstart.rst

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/