cirxe0n / bloomon-code-challenge

This is a project based on an assignment given by Bloomon.

Bloomon - Code Challenge

This is a project based on an assignment given by Bloomon. The assignment description can be found here.

Table of contents:

• Prerequisites
• Usage
  • Usage: Docker
  • Usage: Manual
• Run Tests

Prerequisites

• Docker

Optional:

• Python 3.8

Usage

Usage: Docker

1. Make sure Docker is installed and running properly.
2. Open the terminal and go to the directory of this project.
3. In case necessary, you can add additional input files in the directory inputs. The application will process all the input files in the directory. Note: Make sure the files are in the correct format!
4. Run the following command to build the docker image:

   $ docker build -t cirx-bloomon .
   

5. Run the following command to run the docker image:

   $ docker run -v $PWD/outputs:/usr/src/app/outputs cirx-bloomon
   

6. The results of the input files are placed in the directory outputs after a successful run.

Usage: Manual

1. Make sure Python is installed and running properly.
2. Open the terminal and go to the directory of this project.
3. Run the following command to run the application.

   $ python3 main.py
   

Run Tests

1. Make sure Python is installed and running properly.
2. In case necessary, activate a virtual environment for this project.
3. Run the following command to install the required packages for this project.

   $ pip install -r requirements.txt
   

4. Run the following command to run the tests.

   $ pytest