geotaste

Code, notebooks and resources for a "Geography of Taste", based on Shakespeare & Company Project Datasets

Python 3.10 / Dash 2.13 / Plotly 5.17 / Flask 2.2

Installation

• Clone repository:

  git clone https://github.com/Princeton-CDH/geotaste
  cd geotaste

• Install pyenv if you don't have it:

  curl https://pyenv.run | bash

• Make python environment:

  vnum=$(cat .python-version)
  pyenv install $vnum
  pyenv shell $vnum
  python -m venv venv

• Activate python env:

  . venv/bin/activate
  pip install -qU pip wheel

• Install:

  pip install -e .

• Run locally:

  geotaste-app

• Navigate to http://localhost:1919.

Testing

• Install requirements to develop/test

  pip install -r dev-requirements.txt

• Install chromedriver. For linux, see instructions here; for windows see here. For mac/OSX:

  # install brew if you don't have it yet:
  bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
  
  # use brew to install chromedriver
  brew install --cask chromedriver

• Run pytest:

  pytest --headless --cov

Documentation

• See full code documentation here. To generate documentation locally using sphinx:

  # install requirements to develop/test
  pip install -r dev-requirements.txt
  
  # generate html
  cd sphinx-docs
  make html

• Check documentation coverage:

  make html -b coverage

Credits

• Director: Joshua Kotin
• Technical Lead: Ryan Heuser
• Project Manager: Fedor Karmanov
• Advisers
  • Eric Bulson
  • Effie Rentzou
  • Robert Spoo
  • Keri Walsh

License

This project is licensed under the Apache 2.0 License.

©2024 Trustees of Princeton University. Permission granted for non-commercial distribution online under a standard Open Source license.