Metadata-Version: 2.1
Name: kc_diagnostics
Version: 1.0.7
Summary: Package to generate diagnostics messages.
Home-page: https://github.com/fawad1985/kc-diagnostics
Author: Fawad Mazhar
Author-email: fawad.mazhar@nordcloud.com
License: UNKNOWN
Download-URL: https://github.com/fawad1985/kc-diagnostics/archive/1.0.7.tar.gz
Description: # Diagnostics Pypi
        Fawad Mazhar <fawad.mazhar@nordcloud.com> 2019
        
        ## Overview
        A python package that can be included into your serverless projects. This package is tailored for AWS lambda.  
        
        The package generates necessary alerts based on incoming message. It first reads a configuration file and based on that, it returns alerts along with the available translations. 
        
        ## Runtime
        Python v2.7
        
        ## Pre-requisites
        You will need to install:
          * Python
          * pip
          
        ## Install
        ```
        pip install kc-diagnostics
        ```
        
        ## Getting Started
        ```
        from kc_diagnostics import Diagnostics
        diagnostics = Diagnostics()
        alerts = diagnostics.generate_alerts( dumped_json )
        ```
        
        ## Prerequisites for the consuming application
        Install dependenies
        ```
          pip install boto3
        ```
        Export required environment variables:
        ```
        export TARGET_AWS_REGION=
        export BUFFERS_TABLE_NAME=
        export TRIGGERS_TABLE_NAME=
        ```
        Make sure these dynamodb tables exist in your desired AWS account.
        
        Add permissions to your lambda function. For example:
        ```
        Effect: Allow
        Action:
          - dynamodb:Query
          - dynamodb:Scan
          - dynamodb:GetItem
          - dynamodb:PutItem
          - dynamodb:UpdateItem
          - dynamodb:BatchGetItem
        Resource:
          - {"Fn::Join": ["", ["arn:aws:dynamodb:", {"Ref": "AWS::Region"}, ":", {"Ref":"AWS::AccountId"}, ":table/${BUFFERS_TABLE_NAME}"]]}
          - {"Fn::Join": ["", ["arn:aws:dynamodb:", {"Ref": "AWS::Region"}, ":", {"Ref":"AWS::AccountId"}, ":table/${TRIGGERS_TABLE_NAME}"]]}  
        ```
        
        ## Available Translations
        ```
        German
        Spanish
        French
        Italian
        Portuguese
        ```
Keywords: AWS,IoT,Diagnostics,Lambda
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 2.7
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
