https://github.com/zehengl/lighten-up-calgary

A playground for YYC Christmas light displays
https://github.com/zehengl/lighten-up-calgary

christmas-lights python yyc

Last synced: 27 days ago
JSON representation

A playground for YYC Christmas light displays

• Host: GitHub
• URL: https://github.com/zehengl/lighten-up-calgary
• Owner: zehengl
• License: mit
• Created: 2020-12-27T08:37:31.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2024-04-08T14:54:58.000Z (about 1 year ago)
• Last Synced: 2024-04-08T18:16:07.217Z (about 1 year ago)
• Topics: christmas-lights, python, yyc
• Language: Python
• Homepage:
• Size: 3.83 MB
• Stars: 3
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


    



# lighten-up-calgary

![coding_style](https://img.shields.io/badge/code%20style-black-000000.svg)

A playground for YYC Christmas light displays

## Environment

- Python 3.9

- Windows 10

## Install

Create a virtual environment.

    python -m venv .venv

    .\.venv\Scripts\activate

Then install dependencies.

    pip install -r .\requirements.txt

> Use `pip install -r requirements-dev.txt` for development.

## Usage

**IMPORTANT:** You need a GCP API key for geocoding and MapQuest API key to get the optimized route.

Create a `.env` file to store your GCP API key and MapQuest API key.

    # .env

    # required

    MAPQUEST_KEY="xxx"

    GCP_KEY="yyy"

### Crawling address data from [Lighten UP Calgary][1] for year 2020

    python .\crawl.py 2020

Address data will be saved in `2020.json` located at the `data` folder. Addresses come with latitude/longitude and are formatted.

### Visualizing address data

    python .\display.py

Interactive html files `display.html` and `route.html` will be saved at the `output` folder.

1. Given a starting location and a list of addresses, find the best route to see all light displays (`route.html`)

   ![](examples/route.png)

   > Estimated time for the trip is printed in the console.

2. Simply show all the light displays (`display.html`)

   ![](examples/display.png)

### Demo Webapp

    python .\app.py

## Credits

- [Lighten UP Calgary][1]

- [Santa Claus Icon][2] by [Alpár-Etele Méder][3]

[1]: https://lightenupcalgary.ca/

[2]: https://www.iconfinder.com/icons/1651938/christmas_claus_santa_icon

[3]: https://www.iconfinder.com/pocike