gorskie / capstone2021

Capstone2021

A client/server application to ownload Regulations.gov.

Setup

• Create and activate a virtual environment

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

• Install source code as a module

  The project is organized into multiple modules, which must each be installed as "editable" (using the -e switch on pip):

  pip install -e mirrulations-client
  pip install -e mirrulations-core
  pip install -e mirrulations-dashboard
  pip install -e mirrulations-mocks
  pip install -e mirrulations-work-generator 
  pip install -e mirrulations-work-server
  

Configuration Files

The client and work generator use environment variables to load key values. You can either set the relevant values as environment variables or create a .env file in the relevant module:

• mirrulations-client

  Place the .env file in the mirrclient folder:

  WORK_SERVER_HOSTNAME=work_server
  WORK_SERVER_PORT=8080
  API_KEY=YOUR_KEY
  

• mirrulation-work-generator

  Place the .env file in the mirrgen folder:

  API_KEY=YOUR_KEY
  

  To get an api key, visit here. Check client docs for more information.

Run Static Analysis and Tests

Type make to run all.

Type make static for only static tests.

Type make test for only pytest. Alternatively, run pytest in the root of the project to run all tests. You can run pytest in any of module folders (e.g. in mirrulations-client) to run tests for just that module. Note that there are pytest.ini files in each module as well as a global pytest.ini.

• Static analysis uses flake8, pycodestyle, and pylint
• pytest uses a coverage metric of 95%.
• NOTE: Sometimes if pytest is installed globally, the virtual environment will use that instead. Simply exit and reenter the virtual environment to resolve this. Alternatively, uninstall pytest from the global packages (pip3 uninstall pytest in new termainal).

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 plumbing 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])
• Trae Freeman ([e-mail])
• William Brandes ([e-mail])