Data Simulator

Data simulator for different project with custom configuration

Development

Dev Prerequisites

Name	Version
Python	3.7
pipenv(Python module)	2018.11.26 or up

Environment setup

1. Initialize environment variable

   cp sample.env .env

2. Initialize Dev Python environment with pre-commit

   make pre-commit

3. Enter the environment and start developing

   pipenv shell

4. Commit your code

   make commit

Formatting

This project uses black and isort for formatting

make reformat

Linting

This project uses pylint and flake8 for linting

make lint

Testing

This project uses pytest and its extension(pytest-cov) for testing

make test

Deployment

Deployment Prerequisites

Name	Version
Docker	19.03.6
docker-compose	1.17.1

Deployment Steps

1. Build the image or pull from ECR

   docker-compose build

   This will build the image with tag private-cloud-streaming:test

2. Start containers

   docker-compose up -d

Contribution

• Darkborderman/Divik(reastw1234@gmail.com)
• grandq33769/Aiden Leung(grandq33769@gmail.com)