Metadata-Version: 2.1
Name: cloudconformity
Version: 0.1.2
Summary: Cloud Conformity template scanner tool
Home-page: https://github.com/JustinDPerkins/cloudconformity
Author: Justin Perkins
Author-email: justin_perkins@trendmicro.com
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Requires-Dist: requests

# Cloud Conformity Template Scanner API tool

This is a python package to Cloud Conformity Template Scanner. 

## Installing

To start using we need to setup the config.ini file first.
Navigate to the install pip package. for example on windows "C:\Users\Me\AppData\local\programs\python\..
find config.ini
Add your apiKey and endpoint region.
For reference please check out the conformity API documentation.
https://github.com/cloudconformity/documentation-api

```
[DEFAULT]
apiKey = abcde1234
EndPoint = 'https://us-west-2-api.cloudconformity.com/v1'
```
## Running a scan

Finally, we can scan a CloudFormation Template for misconfigurations before deployment into your AWS infrastructure.

We can scan by default or failures using either [all, fail]
Alternatively, we can filter by severity [Extreme, Very High, High, Medium, Low]

For example, a scan looking for any failure in your template
```
cloudconformity --scan fail C:\MyExample\template.yaml
```
Another example, a scan looking for extreme failures in your template
```
cloudconformity --scan extreme C:\MyExample\template.yaml
```
To see the original json response from API call
```
cloudconformity --scan default C:\MyExample\template.yaml

