Skip to content
This repository has been archived by the owner on Feb 11, 2021. It is now read-only.

Latest commit

 

History

History
100 lines (75 loc) · 3.8 KB

README.md

File metadata and controls

100 lines (75 loc) · 3.8 KB

InGraph

InGraph ain't template generator 😜

InGraph is a Declarative Infrastructure Graph DSL for AWS CloudFormation.

  • Declarative: Never again abstract away from CloudFormation. Simply declare your infrastructure components, without the hassle of YAML, and preserve the strict semantic of the AWS CloudFormation language. Veterans, build on top of your knowledge. Beginners, learn CloudFormation effectively.

  • Composable: Create encapsulated components with their assets and dependencies, then share or compose them to build more complex infrastructures. From simple nodes to your whole graph, everything is a deployable infrastructure unit.

  • Integrated: Leverage the evergrowing Python ecosystem. Benefit from static type checking, take advantage of autocompletion in your editor, or even consume open infrastructure components via the Python Package Index, among others.

Learn how to use InGraph in your own project.

Installation

InGraph requires Python 3.8 or newer. Feel free to use your favorite tool or pip to install the ingraph package.

python3.8 -m pip install --upgrade --user ingraph

Verify your installation by invoking the ig command. You should see a welcome screen.

Note that this project relies on InGraph AWS to provide access to the latest native AWS CloudFormation resources, automatically.

Example

We have several examples on the website. Here is the first one to whet your appetite.

ig cfn -i example.py -r HelloWorld -o example.yaml

InGraph Example

This example creates a simple AWS Lambda function that returns a "Hello, World!" message.

You'll notice that CloudFormation parameters, along with their types and default values are simple constructor parameters, or that CloudFormation outputs are class attributes, or even that CloudFormation resource names are derived from variable names. It's only a taste of what is in store for you.

Contributing

The primary purpose of this project is to continue to evolve the core of InGraph. We are grateful to the community for any contribution. You may, for example, proof-read the documentation, submit bugs and fixes, provide improvements, discuss new axes of evolution, or spread the word around you.

Thanks

We want to thank and express our gratitude to Ben Kehoe. Without his guidance and support, this project wouldn't have been possible.

License

Unless otherwise stated, the source code of the project is released under the GNU Affero General Public License Version 3. Please note, however, that all public interfaces subject to be embedded within the source code of your infrastructure are part of the InGraph AWS project that is released under the Apache License Version 2.