francisseverino / capstone2021

Capstone2021

A complete senior capstone project. The project requires use of a Python virtual environment and installation of the project as an editable module. Additionally, we make use of make in order to run tests.

Setup

• Create/Activate a virtual environment

  python3 -m venv .venv
  source .venv/bin/activate
  

• Install source code as a module

  pip install -e .
  

• Download docket IDs into the src/c21server/data folder. For now they should be stored in said folder in a text file named dockets_0.txt

Run Static Analysis and Tests

Type make to run: Type make static for only static tests Type make test for only pytest

• Static analysis using flake8, pycodestyle, and pylint
• Run pytest with coverage. The coverage metric is set to 75% temporarily, until 95% is reached.
• Sometimes if pytest is installed globally, the virtual environment will use that instead. Simply exit and reenter the virtual environment to resolve this.

Architecture

The image below shows the overview of the architecture for our system. Right now, the portions in blue are implemented at a basic level. Those in red are the remaining parts we need to connect. Regardless, the image shows the relationship between the working parts but also includes the plan over the next few weeks.

Contributors

• Abdullah Alharbi ([e-mail])
• Alex Meci ([e-mail])
• Ben Coleman ([e-mail])
• Colby Hillman ([e-mail])
• Emily Heiser ([e-mail])
• Francis Severino-Guzman ([e-mail])
• Jarod Frekot ([e-mail])
• John Lapatchak ([e-mail])
• Jonah Beers ([e-mail])
• Jorge Aguilar ([e-mail])
• Juan Giraldo ([e-mail])
• Kylie Norwood ([e-mail])
• Larisa Fava ([e-mail])
• Riley Kirkpatrick ([e-mail])
• Ryan Ballek ([e-mail])
• Trae Freeman ([e-mail])
• William Brandes ([e-mail])