3bf68e464a
As a newer project, Spyglass is still a work in progress in terms of its styling. This change is meant to help improve readability and compliance of Spyglass source code. To match other Airship projects, this change implements YAPF into tox so linting is automatically ran. This will hopefully keep formatting grey areas styled consistently. PEP-8: https://www.python.org/dev/peps/pep-0008/ OpenStack Style Guidelines: https://docs.openstack.org/hacking/latest/user/hacking.html PEP Index: https://www.python.org/dev/peps/ Depends on https://review.openstack.org/#/c/648764. Change-Id: I45b19cc8a7932fd7823dcb69f64a0a1bf19fc434
1.9 KiB
Developer Quickstart Guide
To run your first spyglass job, follow these steps from inside the airship-spyglass directory.
Install external dependencies if not already installed.
sudo apt install -y python3-pip sudo apt install -y tox
Set up an environment with tox.
tox -e py36 --notest
Enter the tox environment.
source .tox/py36/bin/activate
Install spyglass in the tox environment.
pip install -e .
Run spyglass on the example files to generate an intermediate document.
mkdir intermediate spyglass -g -s airship-seaworthy -t tugboat -idir intermediate --excel_spec spyglass/examples/excel_spec.yaml --excel spyglass/examples/SiteDesignSpec_v0.1.xlsx --additional_config spyglass/examples/site_config.yaml --template_dir spyglass/examples/templates/
Run spyglass on the intermediate document to generate manifests.
mkdir manifest_dir spyglass -m -i intermediate/airship-seaworthy_intermediary.yaml -mdir manifest_dir/ -tdir spyglass/examples/templates/