Managing Prolific Studies with Jupyter Notebook

The notebook study-management.ipynb demonstrates how Prolific's API can be used to create and manage a stratified study.

A minimal API for Prolific and Qualtrics is implemented in the file APIs.py. Both APIs require API keys, they can set via environment variables or in the file .env. See .env.default for details.

Setup

This project uses Jupyter Notebooks. To reduce the dependencies, this repository does not depend on notebook locally, but instead relies on a globally installed Jupyter Notebook installation. If you do not want to install Jupyter Notebook globally, see the alternative instructions below. You can skip steps 1-3 if you already have Jupyter Notebook installed.

1. Install python 3.11 (other versions will probably also work)
2. Install pipx
3. Install notebook in pipx (pipx install notebook)
4. Install pipenv in pipx (pipx install pipenv)
5. Make the pipenv kernel available to your notebook installation pipenv run python -m ipykernel install --name prolific-scripting --user (or automate this process for all pipenv kernels)
6. Clone repo (git clone <repo>)
7. Install dependencies (pipenv install)
8. Run jupyter-notebook

Alternative setup

1. Install python 3.11
2. Install pipenv (pip install --user pipenv)
3. Clone repo (git clone repo)
4. Install dependencies (pipenv install)
5. Add Jupyter Notebook to local dependencies (pipenv install notebook)
6. Run pipenv run jupyter-notebook
7. Please do not commit the updated Pipfile with the notebook dependency