Metadata-Version: 2.1
Name: fdbk-dynamodb-plugin
Version: 3.0.0
Summary: DynamoDB plugin for fdbk
Home-page: https://github.com/kangasta/fdbk_dynamodb_plugin
Author: Toni Kangas
License: UNKNOWN
Description: # fdbk_dynamodb_plugin
        
        [![Build Status](https://travis-ci.org/kangasta/fdbk_dynamodb_plugin.svg?branch=master)](https://travis-ci.org/kangasta/fdbk_dynamodb_plugin)
        
        AWS Dynamo DB wrapper for fdbk.
        
        ## Installation
        
        Run:
        
        ```bash
        pip install fdbk_dynamodb_plugin
        ```
        
        to install from [PyPI](https://pypi.org/project/fdbk_dynamodb_plugin/) or download this repository and run
        
        ```bash
        python setup.py install
        ```
        
        to install from sources.
        
        ## Testing
        
        Check and automatically fix formatting with:
        
        ```bash
        pycodestyle fdbk_dynamodb_plugin
        autopep8 -aaar --in-place fdbk_dynamodb_plugin
        ```
        
        Run static analysis with:
        
        ```bash
        pylint -E --enable=invalid-name,unused-import,useless-object-inheritance fdbk_dynamodb_plugin
        ```
        
        Run unit tests with command:
        
        ```bash
        python3 -m unittest discover -s tst/
        ```
        
        Get test coverage with commands:
        
        ```bash
        coverage run --branch --source fdbk_dynamodb_plugin/ -m unittest discover -s tst/
        coverage report -m
        ```
        
        ## Cloud deployment
        
        In addition to the plugin, this repository includes CloudFormation template for setting up the DynamoDB tables as well as the related IAM resources and a Chalice app that implements a simple serverless backend to view overview of the data.
        
        The CloudFormation template is available in [fdbk_tables.template.yaml](./fdbk_tables.template.yaml). It setups both of the tables, topics and data, with pay-per-request billing mode.
        
        The chalice implementation for serverless backend is located in [serverless-backend/](./serverless-backend/). The application configuration in [serverless-backend\.chalice\config.json](./serverless-backend\.chalice\config.json) must be updated with your environment specific resources. After updating the configuration, the app can be deplyed with
        
        ```bash
        chalice deploy
        ```
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
