Team Manicotti Senior Project

The moment you've all been waiting for...is here!

Requirements

• Python 3.6
• MySQL 8.0.18
• The Python packages listed below:
  • gunicorn
  • falcon
  • pytest (development only)
  • pylint (development only)
  • sentry-sdk[falcon]==0.13.1

or

• Docker

Code Coverage & Pipeline Status

How to Run

Creating Environment Files

For any of the below methods, environment files need to be created to tell the application how to access Sentry, if desired. The following environment files are needed:

• .sentry_dsn (optional, for logging errors in Sentry)

These files do not follow the envfile convention, they instead follow the Docker secrets convention of only containing the value itself. So instead of putting KEY=VALUE, simply put VALUE.

Docker (from repository)

1. Open the file docker-compose-local-image.yml. For the image: line, edit this to point to the URL of the image you want from the Container Repository. The value after the colon can be a commit UUID, a tag name, or a branch name.
2. Login to the repository via Docker via docker login registry.gitlab.com -u <gitlabUsername> -p <accessToken>, where accessToken is an API token created from here. Only the API access permission is needed.
3. Run the command docker-compose -f docker-compose.yml -f docker-compose-local-image.yml up in the project root directory, or use docker-compose --build -f docker-compose.yml -f docker-compose-local-image.yml up -d to run it as a daemon.

Docker (building image)

1. Run the command docker-compose -f docker-compose.yml -f docker-compose-local.yml up in the project root directory, or use docker-compose -f docker-compose.yml -f docker-compose-local.yml up -d to run it as a daemon.

• If running interactively, simply kill the application with Ctrl+C.
• To remove the container, run docker-compose -f docker-compose.yml -f docker-compose-local.yml down.
• If you've made changes and want to re-build, run the above commands with --build appended to force a re-build.

Manual Setup

1. Run pip install -r seniorproject/requirements.txt from the root of the project directory.
2. Then, run the application using the command gunicorn seniorproject.api:API.

• You can kill the application with Ctrl+C.