Quickstart

from deutero import Deutero

client = Deutero()

project = client.projects.create(name="Onboarding research")
study = client.studies.create(
    project_id=project.id,
    name="Why new users drop off",
    survey_type="user_experience",
    research_question="Where does onboarding lose people?",
    target_population="Product managers at 50-500 person companies",
)

client.welcome.set(
    study.id,
    message="Thanks for joining! This takes about 10 minutes.",
    consent=True,
)

client.questions.create(
    study.id,
    question="Walk me through your first day with the product.",
    max_turns=6,
)
client.questions.create(
    study.id,
    question="How easy was setup?",
    qtype="scale",
    scale={"minScale": 1, "maxScale": 5, "minLabel": "Very hard", "maxLabel": "Very easy"},
)

report = client.questions.validate(study.id)
print("Ethics check passed:", report.ethics_check.passed)

personas = client.personas.generate(study.id, count=1)
run = client.simulations.run(study.id, persona_id=personas.personas[0].id)
print("Simulation started:", run.id, run.status)

client.studies.publish(study.id)

recruitment = client.recruitment.get(study.id)
print("Share this link:", recruitment.participation_url)

stats = client.studies.get_stats(study.id)
print(f"{stats.completed_interviews}/{stats.total_interviews} completed")