Scenery Generator

Generates Scenery class files from the Cloudformation Documentation

Setup

On OSX:

brew install python
pip install virtualenv
virtualenv /path/to/scenery-generator/environment/
cd /path/to/scenery-generator/environment/
git clone ...
source /path/to/scenery-generator/environment/bin/activate
pip install beautifulsoup4
pip install -e git+https://github.com/pwdyson/inflect.py#egg=inflect

Usage

This library contains two classes:

• Scraper: Responsible for fetching data and parsing HTML from the AWS documentation. It has three functions:
  • Constructor: Accepts a URL of the AWS CloudFormation Documentation
  • get_documentation_pages: Accepts a string representing the table of contents page of the amazon docs. Returns a dict in the format:

{ 'AWS::Resrouce::Type': BeautifulSoupObject, ...}

• get_properties: Accepts a BeautifulSoup object representing the (Property) Type documentation page, and parses it to find all of the types. Returns a list of dicts representing each property. For example:

[{
  "list": false,
  "name": "Description",
  "type": "String"
},
{
  "list": true,
  "name": "GroupSet",
  "type": "String"
},
{
  "list": false,
  "name": "PrivateIpAddress",
  "type": "String"
},
{
  "list": true,
  "name": "PrivateIpAddresses",
  "type": "PrivateIpAddress"
},
... ]

See generate_property_map.py for an example of how to use this class.

• Generator: Responsible for generating Scenery class files through the magic of string interpolation and the use of the Scraper class to fetch data from the web. The code is pretty self-explanatory -- see generate_resource_types for an example of how to use this class.

License

This Software is licensed under the MIT license. See the LICENSE file.