Git Product home page Git Product logo

student-information-system's Introduction

Student Information System

A command-line interface (CLI) that enables Students and Instructors to perform various tasks.

About

This CLI is written in Python and communicates with a remote MySQL database. It has a MVC architecure aided by a simple Router that enables controllers to communicate with each other and display their views.

Usage (Mac)

First, clone the repo:

$ git clone https://github.com/MatthewKosloski/student-information-system.git

Then, create a virtual environment for the project (make sure you're in the project's root directory):

$ virtualenv student-information-system

Start up the virtual environment (make sure you're in the project's root directory):

$ source bin/activate

Run the below command to install the packages found in requirements.txt:

$ pip install -r requirements.txt

Execute the script:

$ python app.py

Usage (Windows)

First, clone the repo to the desktop:

$ git clone https://github.com/MatthewKosloski/student-information-system

From the desktop, run the following command to create a virtual environment in the project folder:

$ py -m virtualenv student-information-system

Next, change directory to the project folder and activate the virtual environment:

$ source Scripts/activate

Then, install the requirements:

$ py -m pip install -r requirements.txt

Finally, run the app:

$ py app.py

Installing Packages

If you install a package via Pip, please save it to requirements.txt like so:

$ pip freeze > requirements.txt

Committing changes to your branch

Once you're finished making changes in your branch, first add them to the staging area:

$ git add .

Next, commit them with a helpful message indicating your changes:

$ git commit -m "made changes"

Then, push changes to your branch:

$ git push origin <branch name>

I'll then make a pull request to merge your changes to the master branch.

Resources

Notes

Peewee doesn't support an ENUM type, so we must use integers instead.

The letter_grade column in the registration table takes the following integers:

  • 1 (A)
  • 2 (B)
  • 3 (C)
  • 4 (D)
  • 5 (F)

The meet_day column in the section table takes the following integers:

  • 1 (M)
  • 2 (T)
  • 3 (W)
  • 4 (R)
  • 5 (F)
  • 6 (MWF)
  • 7 (TR)

The type column in the section table takes the following integers:

  • 1 (lecture)
  • 2 (online)

The sex column takes the following integers:

  • 1 (male)
  • 2 (female)

student-information-system's People

Contributors

matthewkosloski avatar paulbgovst avatar

Stargazers

Roman avatar

Watchers

James Cloos avatar  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.