Git Product home page Git Product logo

sniper's Introduction

Introduction

Sniper is an application that interfaces with the Rutgers Schedule of Classes and notifies users via email/text when a course opens up.

It uses

  • Flask for the application framework
  • SQLAlchemy for ORM
  • Twilio for text communication
  • Requests for interfacing with the Rutgers Schedule of Classes.
  • Flask-mail for interfacing with Gmail SMTP servers (for email notifications).

You can check out the live version if you want to simply use its functionality

Installation

You can setup an instance of sniper on your own Linux machine.

  1. Start by setting up a python virtualenv
  2. Install the python packages in requirements.txt by running pip install -r requirements.txt.
  3. Create a db/ directory in the sniper folder (alongside app.py).
  4. Create empty database tables by running python -c "from models import db; db.create_all()"
  5. Copy secrets-example.py to secrets.py. Edit the mail_username and mail_password fields to your SendGrid account details (if you want sniper to send you email).
  6. Run app.py python app.py. You should be able to visit http://localhost:5000/ and input a class to snipe.

When you input a snipe, you should see it under db/production.db in the user and snipe tables.

If you run cron.py (python cron.py), all the courses in the database will be checked and the corresponding users will be notified if the class is open. You can run cron.py in a cronjob to automatically check for course openings.

Example: Put */15 * * * * /path/to/virtualenv/bin/python cron.py into crontab -e to automatically check for openings every 15 minutes.

sniper's People

Contributors

v avatar adispen avatar kaitcov avatar jpaik avatar samgdf avatar

Watchers

James Cloos avatar Ryan Morey avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.