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.
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.
- Install python 3.11 (other versions will probably also work)
- Install pipx
- Install notebook in pipx (
pipx install notebook
) - Install pipenv in pipx (
pipx install pipenv
) - 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) - Clone repo (
git clone <repo>
) - Install dependencies (
pipenv install
) - Run
jupyter-notebook
- Install python 3.11
- Install pipenv (
pip install --user pipenv
) - Clone repo (
git clone repo
) - Install dependencies (
pipenv install
) - Add Jupyter Notebook to local dependencies (
pipenv install notebook
) - Run
pipenv run jupyter-notebook
- Please do not commit the updated Pipfile with the notebook dependency