Skip to content

Working with Jobboard API to perform actions needed by Vector Institute

Notifications You must be signed in to change notification settings

VectorInstitute/Vector-Jobboard

Repository files navigation

Vector-Jobboard

Working with Jobboard API to perform actions needed by Vector Institute

Setup

In order to run the code in this repository, clone it and add a file called config.ini. This is where the script will look for the Jobboard API key and the GitHub Access token. The structure of the file should like the following:

[JOBBOARD]
api_key = <your_key_here>

[GITHUB]
access_token = <your_access_token_here>

Jobboard Api Key

The API key for Jobboard can be found here: https://canadaai.jobboard.io/admin/api_keys

Github Access Token

To obtain your github access token for the above config.ini file, use the followings steps:

  1. Log into github.com
  2. In the top right corner, click on your logo and go to Settings
  3. At the very bottom of the left-hand side, click Developer settings
  4. On the left-had side click Personal access token and then Tokens (classic)
  5. Click Generate new token and then click Generate new token (classic)
  6. Give the token whatever name you want in the Note section
  7. Turn the Expiration to No expiration
  8. Click the button to checkmark repo (Full control of private repositories)
  9. Scroll to the bottom and click Generate token
  10. Copy the generated token and place it in your config.ini file

Usage

Get all Exports

To obtain all the exports (jobs, profile, employer) from Jobboard, simply run the pull_all_exports.exe file and wait for it to finish. Once it is complete, visit whichever shared Google sheet you are interested in (in the shared Google drive). In the menu bar you will see REFRESH HERE, click that, followed by Refresh Data and wait for the script to finish running.

You may get an error message saying:

ValueError: Response is bad:
<Response [500]>

In this case, simply re-run the program and it should work.

Mass Edit

Use the following steps to bulk update jobs, profiles, or employers:

  1. Start at the desired Google sheet
  2. Download a CSV version of the file (File > Download > Comma Separated Values (.csv)) and save it in the same folder as the mass_edit.exe (do not rename the CSV)
  3. Remove all columns that you do not wish to update
    • Never remove the first column (either called ID or token)
  4. Remove the rows that you do not wish to update. Each row corresponds to a job, profile, or employer
  5. Update the values that you need to (you can leave values unchanged as well)
  6. Run the mass_edit.exe and select the file that you have just edited. All changes will make their way to Jobboard

Note: for some reason, updating a profile also hides the profile so do not bulk edit profiles for now.


Troubleshooting

Executable not working

If either the pull_all_exports.exe or mass_edit.exe are not working, here are the steps to re-create them:

  1. Install the required python packages using the command
python -m pip install -r requirements.txt
  1. Create the executable with the command (with either pull_all_exports.py or mass_edit.py)
pyinstaller --onefile <filename>

About

Working with Jobboard API to perform actions needed by Vector Institute

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages