Dev Ops Project 2

Table of Contents

1. About The Project
2. Getting Started
   • Prerequisites
   • Installation
3. Illustrations
4. Usage
5. Roadmap

About The Project

A simple image captioning web app that allows you to caption images from a URL or a file upload.

This project attempts to utilise various GitHub Action Workflows like Pylint, Dockerization and Deployment to Google Cloud.

Getting Started

Prerequisites

1) Run from source

Set up conda environment

• Create conda environment

  conda create --name <env_name> python=<python_version>

  • Python Version >= 3.8
• Activate conda environment

  conda activate <env_name>

Installation

1. Clone the repo

   git clone https://github.com/timljj/devops_project2.git

2. Install python packages

   pip install -r requirements.txt

Illustrations

App Flow

Image Captioning Flow

• Caption Image From URL

  

  

  

Usage

• If Running From local:

  flask run
  

• If Running using Docker

  docker run -p 5000:5000 myflaskapp
  

• If Running Deployed Website (Note if it doesn't work, it's likely due to billing disabled)

  • URL: https://flaskapp-jq3mz27roq-as.a.run.app

Roadmap

• [DONE] Add Webhook Call from GitHub to Discord
• [DONE] Add GitHub Actions
  • [DONE] Pylint
  • [DONE] Docker
  • [DONE] Google Cloud Run
• [DONE] Add Flask App
• [DONE] Add Image Captioning Model to Flask App
• [DONE] Caption Image from URL
  • [DONE] Display Image
  • [DONE] Display Caption
• [TODO] Caption Image from File Upload