Skip to content

Getting Started

Owen Selles edited this page May 5, 2015 · 19 revisions

Installation & Configuration

qual2db is meant to be easy install and use. It was deliberately built use using standard Python libraries so all you need is Python 2.7 -- no dependencies required.

Requirements

Installation

At this point the best way to use qual2db is to download the code, unzip it somewhere in your workspace and then write scripts in the same directory of the folder that import it as qual2db.

Configuration

Once you have downloaded and unzipped the code you must enter your credentials into the configuration file (config.ini).

###Qualtrics Credentials

Credential Description
basurl Leave this as the default: https://survey.qualtrics.com/WRAPI/ControlPanel/api.php?
User The Qualtrics username of an account with API access
Password The account password
Version The API version. Leave this as the default: 2.3.

###MySQL Credentials

Credential Description
sqlUser MySQL username with read/write privileges
sqlPassword MySQL account password
sqlHost Database server url
sqlDB The database where the qual2db tables will be stored

##Setting up MySQL tables To set up the MySQL table structure write and run a script like this:

import qual2db

qual2db.sqlInterface.configure_db()

This will create all the tables needed to store Qualtrics data. It is recommended that you designate a MySQL database for sole purpose of holding these tables.

Clone this wiki locally