README.md

PackIOT FSC :: Development environment automation

0. Table of contents

• 1. Introduction
• 2. Getting started
• 3. Code linting
• 4. Where to now?

1. Introduction

As mentioned before, in order to facilitate the building and running of the services listed in the docker-compose.yml, the devenv.py, was implemented. This module automates the varios actions that can be performed via Docker Compos

scripts/
├── devenv.py       # The executable module
├── docker          # The library containing the helper scripts
│   ├── build.py
│   ├── clean.py
│   ├── common.py
│   ├── ...
└── README.md       # This very file

2. Getting started

To make the devenv.py module executable, just run the following command at the terminal:

$ chmod +x scripts/devenv.py

Finally, to check out the documentation of each script, you can run:

$ ./scripts/devenv.py usage

3. Code linting

In order to maintain a reasonable level of quality in code production, a Python linting tool was integrated to the project (Prospector). It can be executed via the automation script.

To just lint the code, and receive a report with possible inconsistencies, just run:

$ ./scripts/devenv.py code python lint

4. Where to now?

• Database
• Root
• Table of contents