/ucpd-incident-reporting

This application makes use of scraped incidents from the UCPD Daily Incident Reports and displays them in a handful of ways.

Primary LanguagePythonMIT LicenseMIT

UChicago Incident Page Reporter

This application makes use of scraped incidents from the UCPD Daily Incident Reports and displays them in a handful of ways.

Article(s) Citing this Project

  • UChicago Police Department Incident Reporter: Link
  • The Maroon Launches UChicago Police Department Incident Reporter: Link

Project Requirements

  • Python version: ^3.11
  • Poetry
  • Google Cloud Platform service account with location of the service_account.json file stored in the environment variable: GOOGLE_APPLICATION_CREDENTIALS
  • Google Cloud Platform project ID stored in the environment variable: GOOGLE_CLOUD_PROJECT

Instructions to Run the Project

  1. Go into the base directory of the repository and type poetry shell into the terminal.
  2. Use the make run command.

Technical Notes

  • Any modules should be added via the poetry add [module] command.
    • Example: poetry add black

Standard Commands

  • make: Runs create-requirements and lint, respectively.
  • make create-requirements: Runs the Poetry command that creates an up-to-date requirements.txt file.
  • make lint: Runs pre-commit and creates the requirements.txt file.
  • make run: Starts the FastAPI application.