Home

Getting Started

Installation and Setup

1. Install virtual environment: pip install virtualenv
2. Create virtual environment for your project: virtualenv projectfolder and move to the directory cd projectfolder/
3. Clone repository into src directory: git clone git@github.com:UCF/Search-Service-Django.git src and move to the directory cd src/
4. Activate virtual environment: source ../bin/activate
5. Install requirements: pip install -r requirements.txt
6. Create a gulp config file: cp gulp-config.tmpl.json gulp-config.json, then modify as necessary
7. Install the required npm packages: npm install
8. Make sure the default artifacts are created: gulp default
9. Create a settings_local.py file: cp settings_local.tmpl.py settings_local.py, then modify as necessary
10. Run the deployment steps: python manage.py deploy. This command is the equivelent of running the following individual commands: a. python manage.py migrate b. python manage.py collectstatic -l
11. Run the local server to debug and test: python manage.py runserver

Import Initial Data

Load Fixtures

1. CIPs: python manage.py loaddata cip
2. SOCs: python manage.py loaddata soc
3. Program college and tuition overrides: python manage.py loaddata programs

Run program importers

1. Import programs from APIM
   1. Command: python manage.py import-programs
   2. Requirements:
      • URL of APIM feed of all active programs
2. Import undergraduate catalog data:
   1. Command: python manage.py import-catalog-data
   2. Requirements:
      • Acalog API path
      • Acalog API key
      • Undergraduate catalog ID
3. Import graduate catalog data:
   1. Command: python manage.py import-catalog-data --graduate=True
   2. Requirements:
      • Acalog API path
      • Acalog API key
      • Graduate catalog ID
4. Import tuition data:
   1. Command: python manage.py import-tuition
   2. Requirements:
      • URL of the tuition JSON feed, provided by Student Accounts
5. Import occupational codes (SOCs) and map them to CIPs:
   1. Command: python manage.py import-soc
   2. Requirements:
      • CSV file of SOC codes + CIP code mappings, acquired from the NCES website ("look for SOC to CIP Crosswalk"). The lines above the headings will need to be removed, and the headings renamed to: CIP Code , CIP Title, SOC Code and SOC Title.
6. Import program outcome data (using FETPIP data set from IKM):
   1. Command: python manage.py import-program-outcome-data
   2. Requirements:
      • FETPIP data export from IKM, via an information request. Information request must be performed manually on a yearly basis. See https://ikm.ucf.edu/information-requests/. Excel file provided by IKM must be sanitized manually to:
      • Remove information not specific to UCF (“School” column value !== “UCF”)
      • Move CIPs from the “Program” column to a new, separate column, named “CIP”.
      • Add a dot “.” separator after the 2nd digit of all CIPs
      • Export to CSV
7. Import Bureau of Labor Statistics (BLS) employment projection data for programs:
   1. Command: python manage.py import-projection-data
   2. Requirements:
      • CSV file of BLS employment projection data, which can be downloaded from the BLS website. All the columns right of "Occupational Openings" can be removed, and the columns renamed to title, code, begin, end, change, change_perc and openings.
8. Run teledata importers
   1. Import all teledata:
   2. Requirements:
      • Must be run from a machine with permissions to access our teledata staging table