Add Docker image

.github/workflows/docker-build.yml

@@ -0,0 +1,37 @@
+name: Docker Build
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - master
+
+jobs:
+  docker:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Get current date
+        id: date
+        run: echo "::set-output name=date::$(date +'%m-%d-%Y')"
+
+      - name: Login to DockerHub
+        if: github.ref == 'refs/heads/master'
+        uses: docker/login-action@v1
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+
+      - name: Convert Github Organization to Lowercase
+        run: echo IMAGE_REPOSITORY=$(echo ${{ github.repository }} | tr '[:upper:]' '[:lower:]') >> $GITHUB_ENV
+
+      - name: Build and push
+        id: docker_build
+        uses: docker/build-push-action@v2
+        with:
+          push: true
+          tags: ${{ env.IMAGE_REPOSITORY }}:${{steps.date.outputs.date}}
+
+      - name: Image digest
+        run: echo ${{ steps.docker_build.outputs.digest }}

Dockerfile

@@ -0,0 +1,73 @@
+# Python 3.8
+FROM python:3.9
+
+EXPOSE 8501
+
+# SHELL ["/bin/bash", "--login", "-c"]
+
+LABEL version="0.1.0"
+
+LABEL description="An automated text-mining tool written in Python to measure \
+    the technical responsibility of students in computer science courses, being \
+    used to analyze students' markdown reflection documents and five questions \
+    survey based on Natural Language Processing in the Department of Computer \
+    Science at Allegheny College."
+
+LABEL maintainer="Group 5"
+
+# ENV LANG C.UTF-8
+# ENV LANGUAGE C.UTF-8
+# # ENV LC_ALL C.UTF-8
+# RUN groupadd -r student && \
+#     useradd -m -r -g student -d /home/student -s /usr/sbin/nologin -c "student User" student && \
+#     mkdir -p /home/student/workdir && \
+#     chown -R student:student /home/student
+# COPY . /home/student/GATORMINER/
+
+COPY . /gatorminer
+
+WORKDIR /gatorminer
+
+RUN set -e && echo "Installing Pipenv..." \
+    && pip install pipenv \
+    && echo "Installing dependencies..." \
+    && pipenv install --dev --skip-lock \
+    && echo "Installing SpaCy models..." \
+    && pipenv run python -m spacy download en_core_web_sm \
+    && pipenv run python -m spacy download en_core_web_md
+
+# USER root
+
+# RUN apt-get -y -qq update
+# RUN apt-get install -y make build-essential python3-distutils python3-dev libssl-dev zlib1g-dev \
+#     libbz2-dev libreadline-dev libsqlite3-dev wget curl llvm libncurses5-dev \
+#     libncursesw5-dev xz-utils libffi-dev liblzma-dev python-openssl git curl file
+# ENV HOME /home/student
+# WORKDIR /home/student/GATORMINER
+# VOLUME ["/home/student/GATORMINER"]
+
+# VOLUME = /src/
+# RUN curl https://pyenv.run | bash
+# ENV PATH="$HOME/.pyenv/bin:${PATH}"
+# RUN export PATH="$HOME/.pyenv/bin:${PATH}"
+# RUN echo 'alias python="python3.9"' >> ~/.profile
+# RUN echo 'export PATH="$HOME/.pyenv/bin:$PATH"' >> ~/.bashrc
+# RUN echo 'eval "$(pyenv init -)"' >> ~/.bashrc
+# RUN echo 'eval "$(pyenv virtualenv-init -)"' >> ~/.bashrc
+# RUN /bin/bash -c "source ~/.bashrc"
+# RUN /bin/bash -c "source ~/.profile"
+# RUN pyenv install 3.9.2
+# RUN pyenv global 3.9.2
+# RUN pyenv local 3.9.2
+# RUN /bin/bash --login
+# RUN curl https://bootstrap.pypa.io/get-pip.py -o ~/get-pip.py
+# RUN pyenv exec python ~/get-pip.py
+# RUN pyenv exec python -m pip install pipenv
+# RUN pyenv exec pipenv run python -m pip install Cython wheel setuptools watchdog
+# RUN pyenv exec pipenv install --skip-lock --dev
+# RUN pyenv exec pipenv run spacy download en_core_web_sm
+# USER student
+# ENV USER student
+# CMD pyenv exec pipenv run streamlit run streamlit_web.py
+
+CMD ["pipenv", "run", "streamlit", "run", "streamlit_web.py"]

Pipfile

@@ -10,6 +10,7 @@ pytest = "*"
 pytest-cov = "*"
 
 [packages]
+numpy = "~=1.20.2"
 matplotlib = "*"
 gensim = "~=3.8.3"
 spacy = "~=2.3"

README.md

@@ -4,6 +4,8 @@
 [![codecov](https://codecov.io/gh/Allegheny-Ethical-CS/GatorMiner/branch/master/graph/badge.svg)](https://codecov.io/gh/Allegheny-Ethical-CS/GatorMiner)
 [![Built with spaCy](https://img.shields.io/badge/built%20with-spaCy-09a3d5.svg)](https://spacy.io)
 [![Built with Streamlit](https://img.shields.io/badge/built%20with-Streamlit-09a3d5.svg)](https://www.streamlit.io/)
+[![Docker Build](https://github.com/BennyWestsyde/GatorMiner/actions/workflows/dockerbuild.yml/badge.svg)](https://github.com/BennyWestsyde/GatorMiner/actions/workflows/dockerbuild.yml)
+![Docker Image Version (latest by date)](https://img.shields.io/docker/v/bennywestsyde/gatorminer?label=Last%20Built%20and%20Pushed)
 
 An automated text-mining tool written in Python to measure the technical
 responsibility of students in computer science courses, being used to analyze
@@ -50,6 +52,20 @@ pipenv run python -m spacy download en_core_web_sm
 pipenv run python -m spacy download en_core_web_md
 ```
 
+Alternatively, run a Docker container with all necessary dependencies and Spacy models installed.
+
+Run the Docker container for Mac:
+
+```bash
+sh docker_run_mac.sh
+```
+
+Run the Docker container for Windows:
+
+```
+docker_run_win.bat
+```
+
 ## Web Interface
 
 GatorMiner is mainly developed on its web interface with [Streamlit](https://www.streamlit.io)

readme_docker.md

@@ -0,0 +1,24 @@
+README File For Running Docker Container
+
+The Docker Container contains all of the necessary dependencies and Spacey models already installed
+therefore Gator Miner can be run without downloading everything locally on your machine.
+
+Run the code below to utilize the Docker Container
+
+### Mac:
+
+##### Building:
+Run ```sh docker_build_mac.sh``` for mac
+##### Running:
+
+##### Development command
+
+```sh
+docker run -it -v "$(pwd):/gatorminer" -d -p 8080:8501 gatorminer
+```
+
+### Windows:
+
+##### Building:
+Run ``` sh docker_run_win.sh ``` for windows
+##### Running:

scripts/docker_build.bat

@@ -0,0 +1,2 @@
+@echo [+] (Win_OS) Building Docker Container.
+docker build  -t gatorminer .

scripts/docker_build.sh

@@ -0,0 +1,3 @@
+#!/bin/bash
+printf "\n[+] (Mac) Building Docker Container"
+docker build -t gatorminer .

scripts/docker_run.bat

@@ -0,0 +1,2 @@
+@echo  [+] (Win_OS) Running Docker Container.
+docker container run --name devi -d -p 8501:8501 bennywestsyde/gatorminer && echo "\n\tYou can now view your Streamlit app in your browser.\n\n\tNetwork URL: http://localhost:8501 \n\tExternal URL: http://141.195.4.17:8501"

scripts/docker_run.sh

@@ -0,0 +1,4 @@
+#!/bin/bash
+# printf "\n[+] (Mac) Running Docker Container"
+# docker container run --name devi -d -p 8501:8501 bennywestsyde/gatorminer && echo "\n\tYou can now view your Streamlit app in your browser.\n\n\tNetwork URL: http://localhost:8501 \n\tExternal URL: http://141.195.4.17:8501"
+docker run -it -d -p 8080:8501 gatorminer