Metadata-Version: 2.1
Name: aws-vapor
Version: 0.1.0
Summary: Generates AWS CloudFormation template from python object
Home-page: https://github.com/ohtomi/aws-vapor/
Author: Kenichi Ohtomi
Author-email: ohtomi.kenichi@gmail.com
License: MIT
Keywords: aws cloudformation template generator
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.6
Requires-Dist: cliff

*********
aws-vapor
*********

.. image:: https://img.shields.io/pypi/v/aws-vapor.svg
   :target: https://pypi.org/project/aws-vapor
   :alt: PyPI

.. image:: https://img.shields.io/pypi/status/aws-vapor.svg
   :target: https://pypi.org/project/aws-vapor
   :alt: Status

.. image:: https://img.shields.io/pypi/l/aws-vapor.svg
   :target: https://pypi.org/project/aws-vapor
   :alt: License

.. image:: https://img.shields.io/pypi/pyversions/aws-vapor.svg
   :target: https://pypi.org/project/aws-vapor
   :alt: Python Versions

.. image:: https://travis-ci.org/ohtomi/aws-vapor.svg?branch=eliminate-old-python-support
   :target: https://travis-ci.org/ohtomi/aws-vapor
   :alt: Build Status

.. image:: https://readthedocs.org/projects/aws-vapor/badge/?version=latest
   :target: http://aws-vapor.readthedocs.io/en/latest/?badge=latest
   :alt: Documentation Status

Description
===========

This tool generates AWS CloudFormation template from python object.

Requirements
============

- Python 3.6+

How to install
==============

.. code-block:: bash

   $ pip install aws-vapor

How to use
==========

.. code-block:: bash

   $ aws-vapor --help
   usage: aws-vapor [--version] [-v | -q] [--log-file LOG_FILE] [-h] [--debug]

   AWS CloudFormation Template Generator

   optional arguments:
     --version            show program's version number and exit
     -v, --verbose        Increase verbosity of output. Can be repeated.
     -q, --quiet          Suppress output except warnings and errors.
     --log-file LOG_FILE  Specify a file to log output. Disabled by default.
     -h, --help           Show help message and exit.
     --debug              Show tracebacks on errors.

   Commands:
     complete       print bash completion command
     config         show current configuration or set new configuration
     generate       generate AWS CloudFormation template from python object
     get            download contributed recipe from url
     help           print detailed help for another command

generates AWS CloudFormation template
-------------------------------------

.. code-block:: bash

   $ aws-vapor config set defaults contrib '/path/to/template-dir'
   $ aws-vapor config list
   [defaults]
   contrib = /path/to/template-dir
   $ aws-vapor generate 'template-file' --output '/path/to/json-file'

Examples
========

See https://github.com/ohtomi/aws-vapor/tree/master/examples/

Contributing
============

1. Fork it!
2. Create your feature branch: `git checkout -b my-new-feature`
3. Commit your changes: `git commit -am 'Add some feature'`
4. Push to the branch: `git push origin my-new-feature`
5. Submit a pull request :D

License
=======

MIT

Author
======

`Kenichi Ohtomi <https://github.com/ohtomi>`_


