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 }}

.github/workflows/dockerbuild.yml

@@ -0,0 +1,37 @@
+name: Docker Build
+
+on:
+  schedule: 
+      - cron: "*/60 */24 * * 0"
+  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: Build and push
+        id: docker_build
+        uses: docker/build-push-action@v2
+        with:
+          version: ${{steps.date.outputs.date}}
+          push: true
+          tags: bennywestsyde/gatorminer:${{steps.date.outputs.date}}
+      -
+        name: Image digest
+        run: echo ${{ steps.docker_build.outputs.digest }}

.github/workflows/main.yml → .github/workflows/test.yml

@@ -9,19 +9,20 @@ jobs:
     strategy:
       matrix:
         os: [Ubuntu, MacOS]
-        python-version: [3.6, 3.7, 3.8]
+        python-version: [3.7, 3.8]
     steps:
     - uses: actions/checkout@v2
     - name: Set up Python ${{ matrix.python-version }}
       uses: actions/setup-python@v2
+      id: setup-python
       with:
         python-version: ${{ matrix.python-version }}
-    - name: Install Pipenv
-      run: |
-        pip install pipenv --upgrade
+    - name: Setup Pipenv
+      uses: dschep/install-pipenv-action@v1
     - name: Install dependencies
       run: |
-        pipenv install --dev --skip-lock
+        # install dependencies according to the lock file
+        pipenv install --dev --ignore-pipfile --python ${{ steps.setup-python.outputs.python-version }}
         pipenv run python -m spacy download en_core_web_sm
     - name: Run test with pytest
       run: |

.mdlrc

@@ -1 +1 @@
-rules "~MD013"
+rules "~MD013, ~MD033"

.travis.yml

@@ -21,7 +21,8 @@ before_install:
   # install pyenv with travis-pyenv
   - wget https://github.com/praekeltfoundation/travis-pyenv/releases/latest/download/setup-pyenv.sh
   - source setup-pyenv.sh
-  # install mdl to check markdown
+  - gem install chef-utils -v 16.6.14
+  # install mdl to check markdown beep
   - gem install mdl
 
 notifications:

CONTRIBUTING.md

@@ -51,7 +51,7 @@ code contribution.
 ### Development Environment
 
 In order to contribute code or documentation to the project, the project
-maintainers suggest installing the release of Python versions above 3.6. You can
+maintainers suggest installing the release of Python versions above 3.7. You can
 learn more about installing and managing python versions with `pyenv` from
 [here](https://realpython.com/intro-to-pyenv/). In addition to installing `Git` to
 access the project's GitHub repository, you should also install `Pipenv` for its
@@ -108,9 +108,9 @@ pipenv run streamlit run streamlit_web.py
 #### Develop GatorMiner on Windows
 
 GatorMiner depends on gensim, and gensim requires Microsoft Visual C++ 14.0+. You can check the version you have from
-`Control Panel -> Programs and Features`. To download or update this, go to the 
-[Visual Studio 2019 Downloads](https://visualstudio.microsoft.com/downloads/), scroll down and 
-expand the `Tools for Visual Studio 2019` and click the download link for `Build tools for Visual Studio 2019`. 
+`Control Panel -> Programs and Features`. To download or update this, go to the
+[Visual Studio 2019 Downloads](https://visualstudio.microsoft.com/downloads/), scroll down and
+expand the `Tools for Visual Studio 2019` and click the download link for `Build tools for Visual Studio 2019`.
 
 Once the installer is downloaded, launch it and select the `C++ build tools` option under `Desktop and Mobile`.
 After that select install at the bottom and wait.
@@ -120,7 +120,7 @@ installing, the installer will ask to restart the computer to finish the install
 After your computer has finished installing the C++ build tools, you may need to reinstall the dependencies. To do this,
 just run the `pipenv install --dev` command as previously instructed.
 
-If you still receive the error, delete the `Pipfile.lock` file in the root of the GatorMiner directory and reinstall 
+If you still receive the error, delete the `Pipfile.lock` file in the root of the GatorMiner directory and reinstall
 using the previous command.
 
 #### Test GatorMiner with Sample Data

Dockerfile

@@ -0,0 +1,73 @@
+# Python 3.8
+FROM python:3.8
+
+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,19 +10,21 @@ pytest = "*"
 pytest-cov = "*"
 
 [packages]
+numpy = "~=1.20.2"
 matplotlib = "*"
-gensim = '*'
+gensim = "~=3.8.3"
 spacy = "~=2.3"
 sklearn = "*"
 pytest = "*"
 requests = "*"
 commonmark = "*"
 codecov = "*"
-streamlit = "*"
+streamlit = "~=0.78.0"
 altair = "*"
 textblob = "*"
 scipy = "*"
 pylint = "*"
+importlib-metadata = "*"
 
 [pipenv]
 allow_prereleases = true