Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/willcrichton/cmu-grades

Gets your grades from CMU services
https://github.com/willcrichton/cmu-grades

Last synced: 2 months ago
JSON representation

Gets your grades from CMU services

Awesome Lists containing this project

README

        

cmu-grades
==========

**Note**: If you're just curious about using the Shibboleth/WebISO authentication, take a look at `auth.py`.

CMU-Grades is a Python app for CMU students which will text you via Twilio or email you whenever you get new grades on Blackboard, Autolab, or Academic Audit (i.e. final grades). It also has utilities for accessing your SMC #, mailbox combo, and schedule on SIO.

To setup, first you need to install [pip](https://pypi.python.org/pypi/pip) and run `pip install -r requirements.txt`.

Then, to use the provided authorization functions, you need to change your `config.py` file to look like:

```python
USERNAME = 'ANDREWID'
PASSWORD = 'YOURPASSWORD'
ACCOUNT_SID = 'TWILIO_ACCOUNT_ID'
AUTH_TOKEN = 'TWILIO_AUTH_TOKEN'
PHONE_NUMBER = '+YOUR_PHONE_NUMBER'
TWILIO_NUMBER = '+TWILIO_PHONE_NUMBER'
EMAIL = 'YOUR EMAIL'
EMAIL_PASSWORD = 'YOUR EMAIL PASSWORD'
NAME = 'YOUR NAME'
```

As you can see, using an automated login requires storing your password. Hence, I do not endorse the use of this API on
the grounds of security--storing your password somewhere is bad! But, you know, if you really need automated logins,
the option is there. I personally base64 encoded my password so it's not immediately obvious when you open the file.

To install the texting service, run `python app.py install text`. Similarly, to install the email service, run `python app.py install email`.

To uninstall a service, run `python app.py uninstall text` or `python app.py uninstall email`.