Skip to content

Latest commit

 

History

History
18 lines (12 loc) · 1.95 KB

README.md

File metadata and controls

18 lines (12 loc) · 1.95 KB
Raw

wcsc-metroalerts

NOTICE: PORT FORWARD AT YOUR OWN RISK!

This project was never intended to be deployed on an open port. Because of that there are possible issues, like DEBUG == True in Django settings. You have been warned.

About:

A live WMATA Metro map that shows where incidents are located, where maintenance is happening, and if there are any service advisories. It uses the email that MetroAlerts sends notifications to. Make sure to use a dedicated email account and set rules that send WMATA messages to two folders called 'alerts' and 'advisories'. If you don't the code could pull down random stuff you don't want and then store it locally. The email protocols this project supports are Gmail and Maildir IMAP. Mbox is not in my scope. The IMAP implementation in this project has no way of pulling down emails on it's own. You'll need an email client that supports Maildir. I have personally been using Thunderbird.

Software notes:

  • Python 3.11.2

  • Django 5.0.1

    • Right now, I am using mariaDB instead of the SQLite3 database. You will need to run python3 manage.py makemigrations and python3 manage.py migrate to transfer from SQLite to mariaDB. You'll need to setup a mariaDB database and will need to install the mariadb and mysqlclient Python libraries.
    • If command line isn't your vibe, there's a visual manager for databases called DBeaver Community Edition that I have been using to manage mariaDB. Note: You will still need to use the command line to setup the mariaDB database.

  • When using Gmail, you need to have a Google API project and Google Python libraries. In order to get your API project setup, look at ThePythonCode's guide.