qxf2 / interview-scheduler

This repo contains code needed for the Qxf2 interview scheduler application.

Interview scheduler

This repo contains code needed for the Qxf2 interview scheduler application. Please follow the setup instructions to start using the application.

---

1. MOTIVATION

a. Allow Qxf2 to handle a large volume of interview candidates without having to bother about scheduling

b. Make the interaction with Qxf2 different from other companies

c. Reduce (almost eliminate) exchange of emails between candidate and interviewer

2. SETUP

a. Python

This project uses Python 3.7.4 or higher.

b. Setup your virtualenv

1. Install virtualenv

        pip install virtualenv
   

2. After installing virtualenv open the terminal and go to the directory of your project or the repository exists

3. In the terminal now type the below command

        virtualenv -p <full path to the Python executable> <name of the virtual env>
   
        E.g.: virtualenv -p /c/Python37/bin/python.exe name of the virtualenv
   
        E.g.: virtualenv -p /usr/local/bin/python3.7 name of the virtualenv
   

4. Now it's time to activate your virtualenv. To do that type the below command in the terminal

        (Unix) source (name of your virtualenv)/bin/activate
   
        (Windows)source (name of your virtualenv)/scripts/activate
   

5. You can see your virtualenv name in the terminal. Once you have finished your work you can do the deactivation by typing the below command in the terminal

        deactivate
   

6. From next time onwards you don't need to repeat steps 1 to 4.You can directly goto step 4 and work on your project and to stop you can do step 5

c. Install the required Python modules:

With your virtualenv activated, run the following command:

        pip install -r requirements.txt

d. Google calendar setup

If you are not from Qxf2, please create a token.pickle file using this link: Google Calendar API: Python quickstart

Place the token.pickle file in the root directory of this project (same directory as this readme).

If you are from Qxf2, please ask a colleague for the token.pickle file

e. Verify Google calendar setup

To verify your Google calendar setup, try the following command

        python utils/verify_gcal_setup.py <your_email_id>

If all went well, you should see 10 upcoming events for the email id you provided.

f. Adding Email Configuration

For this application user need to add email_config.py, under qxf2_scheduler folder with details as below:

MAIL_USERNAME = "[e-mail]" MAIL_PASSWORD = "password"

g. Initial db setup

1. Open the interview-scheduler folder and create another folder named "data"(This folder is Database folder)

2. The above created "data" folder will be empty initially. For the first time while creating the db run the following command

    python migrate_db.py db init
   

3. Now We have to migrate the required data to this "data" folder. Migrating Database can be done by using the following command

    python migrate_db.py db  migrate
   

   Once you follow the above step you will see that Database has been created. The created database will be with '.db'extension, i.e (.db)

4. So now we should add the required tables by using the following command

    python migrate_db.py db upgrade
   

   Whenever we change the structure of table we should again "Migrate" and "Upgrade" the db.

5. To check if the tables have been added:

   prerequistie: SQlite3 should be installed in your PC

   Open your Bash terminal go to the interview scheduler directory and move in to the data folder and open the SQlite DB file.

        .open <filename with extension>
   

   You can use SQlite queries to view tables, schema and insert and delete data into tables. NOTE: DATA cannot be migrated. You should add your own data to db and proceed.

6. Run python qxf2_scheduler/setup_db.py for initalizing the candidatestatus table with default values

h. Start the application

To start the application, run

  python run.py

The command should be run from the root directory (same as the directory of this readme). If all goes well, when you visit http://localhost:6464 on your browser, you should see the homepage of the application.