Merge branch 'master' into Installation-Documentation-#57

Pipfile

@@ -18,7 +18,7 @@ pytest = "*"
 requests = "*"
 commonmark = "*"
 codecov = "*"
-streamlit = "*"
+streamlit = "~=0.78.0"
 altair = "*"
 textblob = "*"
 scipy = "*"

codecov.yml

@@ -2,7 +2,12 @@ codecov:
   token: 59a0baf8-461c-4d50-b6d3-ad40bed4ae21
   max_report_age: off
 
-comment: false
+comment:                  # this is a top-level key
+  layout: "reach, diff, flags, files"
+  behavior: default
+  require_changes: false  # if true: only post the comment if coverage changes
+  require_base: no        # [yes :: must have a base report to post]
+  require_head: yes       # [yes :: must have a head report to post]
 
 coverage:
   precision: 2

resources/sample_md_reflections/cs203_lab02/reflection1.md

@@ -0,0 +1,73 @@
+# Reflection by
+
+## Summary Task List for the Laboratory Assignment
+
+- [x] Built and used the current version of GatorMiner.
+- [x] Used ZenHub board.
+- [x] Contributed to new user stories and tasks.
+- [x] Participated in all three scrum meetings.
+- [x] Wrote sentences about your software engineering skills in the assessment document.
+- [x] Completed all writing tasks in the reflection document
+
+## Did you follow the code of conduct during the completion of this project?
+
+Yes
+
+## Did you observe someone who did not follow the code of conduct? Who? How?
+
+No
+
+## Scrum Meetings
+
+### Scrum Meeting One (3/18)
+
+- What did you since last meeting?
+  * Created a group, and decided on a scrum lead
+- What will you do before the next meeting?
+  * Work on getting GatorMiner to work
+- Are there any obstacles in your way?
+  * An error about installing dependencies
+
+### Scrum Meeting Two (3/19)
+
+- What did you since last meeting?
+  * Tried to get GatorMiner working on my own, reinstalled pyenv and virtualenv.
+- What will you do before the next meeting?
+  * Definitely have GatorMiner working
+- Are there any obstacles in your way?
+  * The current dependency issues i'm having while running the ```pyenv install --dev``` command
+
+### Scrum Meeting Three (3/23)
+
+- What did you since last meeting?
+  * Successfully got GatorMiner to work and tested out the different current features of the program
+- What will you do before the next meeting?
+  * Work on the task idea(Docker image), and consult with team frequently about it.
+- Are there any obstacles in your way?
+  * Not currently
+
+## At a high level, what were the most important professional tasks that you completed?
+
+- First task
+  * Communicated with my team members to try and fix the issues we were having with Gatorminer dependencies on windows machines.
+- Second task
+  * Had a google meet with TL to resolve my machines issues.
+- Third task
+  * Created a slack channel as well as snapchat group to frequently and effectively communicate with group.
+
+## At a high level, what were the most important technical tasks that you completed?
+
+- First task
+  * Successfully got GatorMiner working on my machine, by reinstalling pipenv/virtualenv, downloading C ++ tools, and changing the streamlit version in the pipfile to a working version.
+- Second task
+  * Created an issue on the project board regarding the streamlit error I recieved, and assigned myself to start looking for a solution. As well as created a team label, and assigned our team to an issue regarding the creation of a Docker image.
+- Third task
+  * Started reading into other Docker files from different classes and using online sources to start developing a Dockerfile and image for GatorMiner.
+
+## After completing this week of the project, what is a task that you want to practice more? Why?
+
+I would like to practice reading error codes better, so I can be self sufficient in solving my machines common and basic errors. As well as learn more about docker images to able to create one with my group.
+
+## After completing this assignment, what is your biggest concern about team-based software engineering?
+
+I think that effective communication between team members is very important, and I feel my team has been doing a very good job with this.

resources/sample_md_reflections/cs203_lab02/reflection10.md

@@ -0,0 +1,110 @@
+# Reflection by
+
+## Summary Task List for the Laboratory Assignment
+
+- [x] Built and used the current version of GatorMiner.
+- [x] Used ZenHub board.
+- [x] Contributed to new user stories and tasks.
+- [x] Participated in all three scrum meetings.
+- [x] Wrote sentences about your software engineering skills in the assessment document.
+- [x] Completed all writing tasks in the reflection document
+
+## Did you follow the code of conduct during the completion of this project?
+
+Yes.
+
+## Did you observe someone who did not follow the code of conduct? Who? How?
+
+No, everyone had issues but helped each other out and followed the code of conduct.
+
+## Scrum Meetings
+
+### Scrum Meeting One (3/22/21)
+
+- What did you since last meeting?
+
+Work on trying to get GatorMiner working.
+
+- What will you do before the next meeting?
+
+Troubleshoot more.
+
+- Are there any obstacles in your way?
+
+Yes, gensim and pyenv.
+
+### Scrum Meeting Two (3/23/21)
+
+- What did you since last meeting?
+
+Struggle with the python virtual environment.
+
+- What will you do before the next meeting?
+
+Try to figure out how the pyenv works.
+
+- Are there any obstacles in your way?
+
+Pyenv and gensim not wanting to cooperate.
+
+### Scrum Meeting Three (3/25/21)
+
+- What did you since last meeting?
+
+Finalized the installation for GatorMiner, had a successful run.
+
+- What will you do before the next meeting?
+
+We determined our how to approach our jobs and how we were planning accomplishing our tasks.
+
+- Are there any obstacles in your way?
+
+There was a simple implementation that we tried, but it did not work initially. It took a few iterations to get a model that would be ideal to move forward.
+
+## At a high level, what were the most important professional tasks that you completed?
+
+- First task
+
+Learn how to overcome dependencies discrepancies.
+
+- Second task
+
+Communicate within the team to determine tasks.
+
+- Third task
+
+Work with Github and minimize double coding.
+
+## At a high level, what were the most important technical tasks that you completed?
+
+- First task
+
+Pull GatorMiner to begin the project
+
+- Second task
+
+Install required dependencies.
+
+- Third task
+
+Build GatorMiner environment and run
+
+## After completing this week of the project, what is a task that you want to practice more? Why?
+
+Please provide a response to this question.
+I would like to practice working with the Github flow model more often with a team. Working with a team is different then working independently, where you need to communicate and focus on pulling before making changes and have to talk to each other.
+
+## After completing this assignment, what is your biggest concern about team-based software engineering?
+
+Please provide a response to this question.
+Just like with the task that I would like to work on most, working in a group requires a large amount of collaboration. This can be difficult and I am somewhat concerned about this, but as we work more in a group this should become more natural.
+
+3/30/21 Update
+Progress:
+Finished file upload and fixed linting errors
+
+Issues:
+Gensim and linux checks in Github, and single file upload
+
+Future:
+Next meeting we will be assigning new roles for everyone and moving selecting the next issue to work on.

resources/sample_md_reflections/cs203_lab02/reflection11.md

@@ -0,0 +1,82 @@
+# Reflection by
+
+## Summary Task List for the Laboratory Assignment
+
+- [x] Built and used the current version of GatorMiner.
+- [x] Used ZenHub board.
+- [x] Contributed to new user stories and tasks.
+- [x] Participated in all three scrum meetings.
+- [x] Wrote sentences about your software engineering skills in the assessment document.
+- [x] Completed all writing tasks in the reflection document
+
+## Did you follow the code of conduct during the completion of this project?
+
+yes
+
+## Did you observe someone who did not follow the code of conduct? Who? How?
+
+no
+
+## Scrum Meetings
+
+### Scrum Meeting One (3/17)
+
+- What did you do since last meeting?
+
+I tried downloading and running GatorMiner and failed, as I realized that I could not run it within Docker. As a result, I had to go back to troubleshooting an issue I have been having with running python locally since last semester.
+
+- What will you do before the next meeting?
+
+Work on troubleshooting my issues with Python and retrying the run for GatorMiner.
+
+- Are there any obstacles in your way?
+
+The only obstacle currently is that I don't have Python properly installed on my machine.
+
+### Scrum Meeting Two (3/19)
+
+- What did you since last meeting?
+
+I further troubleshooted my issue with Python and found that my best next step would be to uninstall and delete all of the remnants of the previous Python installation. Knowing that, my next best step would be to install the newest version of Python
+
+- What will you do before the next meeting?
+
+Install the newest version of Python and pipenv
+
+- Are there any obstacles in your way?
+
+Not that I can tell.
+
+### Scrum Meeting Three (3/21)
+
+- What did you since last meeting?
+
+I installed the newest version of Python but found that I needed to revert it to Python 3.8 to properly run GatorMiner. I installed Python 3.8 and was able to run GatorMiner, with the exception of a ModuleNotFoundError for gensim.summarization.
+
+- What will you do before the next meeting?
+
+Try and fix my issues with GatorMiner
+
+- Are there any obstacles in your way?
+
+The ModuleNotFoundError :(
+
+## At a high level, what were the most important professional tasks that you completed?
+
+- Using ZenHub
+- Attending all meetings
+- Communicating with and actively participating with my group members
+
+## At a high level, what were the most important technical tasks that you completed?
+
+- Running Python programs with pyenv and pipenv
+- Running streamlit
+- Setting up GatorMiner
+
+## After completing this week of the project, what is a task that you want to practice more? Why?
+
+One task I would like to practice more is to plan out my time better so that I can complete assignments in a more timely fashion, with less additional stress on me.
+
+## After completing this assignment, what is your biggest concern about team-based software engineering?
+
+I have no concerns about team-based software engineering at this time.

resources/sample_md_reflections/cs203_lab02/reflection12.md

@@ -0,0 +1,58 @@
+# Reflection by
+
+## Summary Task List for the Laboratory Assignment
+
+- [☑] Built and used the current version of GatorMiner.
+- [☑] Used ZenHub board.
+- [☑] Contributed to new user stories and tasks.
+- [☑] Participated in all three scrum meetings.
+- [☑] Wrote sentences about your software engineering skills in the assessment document.
+- [☑] Completed all writing tasks in the reflection document
+
+## Did you follow the code of conduct during the completion of this project?
+
+Yes
+
+## Did you observe someone who did not follow the code of conduct? Who? How?
+
+No
+
+## Scrum Meetings
+
+### Scrum Meeting One (03/16)
+- Created the team and talked about how we can complete the objective for Sprint 0
+- Try to figure out to install and test GatorMiner
+- The installation of GatorMiner and figuring out the best way to to test the program
+
+### Scrum Meeting Two (03/18)
+
+- Tried to figure of the installation of GatorMiner, was able to install the program
+- Figure out how write an issue into ZenHub and put labels on the said issue
+- Few group members still have difficulty installing GatorMiner for the project
+
+### Scrum Meeting Three (03/21)
+
+- Continued to work on testing GatorMiner, still need to work on that and install functionality so that can work
+- Work more on trying to figure out the ability to test GatorMiner, finalize the issue we created for ZenHub
+- Still the installation of GatorMiner is not working properly for some individuals
+
+
+## At a high level, what were the most important professional tasks that you completed?
+
+- Understanding and adopting best practices,
+- Interacting with the team members
+- Understanding and avoiding red flags
+
+## At a high level, what were the most important technical tasks that you completed?
+
+- Configuring a development environment for Python
+- Using the GitHub issue tracker
+- Creating and assigning labels to issues in the GitHub issue tracker
+
+## After completing this week of the project, what is a task that you want to practice more? Why?
+
+I will like to practice utilizing the GatorMiner program because I am very intrigued with how it operates. I was able to build the program but I am still having difficulties trying to test the program because I still have to run some functionality on my computer for the testing to work. I am very interested in the idea of GatorMiner so I would like to practice using this program more in the future.
+
+## After completing this assignment, what is your biggest concern about team-based software engineering?
+
+My biggest concern about team-based software engineering is trying to figure out the best time we can meet together and work because of everyone's schedules. My team have had some difficulty with that but we have been able to work past that thankfully and it has not put a wrinkle in any of our future plans. However, right now, that remains my biggest concern compared to everything else.