curious-pyapi 0.1.5__tar.gz → 0.1.7__tar.gz

{curious_pyapi-0.1.5 → curious_pyapi-0.1.7}/CHANGELOG.md

@@ -5,7 +5,7 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [0.1.5]
+## [0.1.7]
 
 ### Added
 

{curious_pyapi-0.1.5 → curious_pyapi-0.1.7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: curious-pyapi
-Version: 0.1.5
+Version: 0.1.7
 Summary: Python interface for Curious API.
 Project-URL: Repository, https://github.com/childmindresearch/curious-pyapi
 Project-URL: Issues, https://github.com/childmindresearch/curious-pyapi/issues
@@ -22,8 +22,8 @@ Classifier: Typing :: Typed
 Requires-Python: >=3.12
 Requires-Dist: fastexcel>=0.21.0
 Requires-Dist: httpx>=0.28.1
-Requires-Dist: polars>=1.44.0
-Requires-Dist: pydantic[email]>=2.13.4
+Requires-Dist: polars>=1.44.1
+Requires-Dist: pydantic[email]>=2.13.5
 Description-Content-Type: text/markdown
 
 # Curious-PyAPI

curious_pyapi-0.1.7/S0-CuriousAccountCreation.ipynb

@@ -0,0 +1,287 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "id": "f06b51dd-6552-4b22-91b9-e6d68880186c",
+   "metadata": {
+    "microsoft": {
+     "language": "python",
+     "language_group": "synapse_pyspark"
+    },
+    "nteract": {
+     "transient": {
+      "deleting": false
+     }
+    }
+   },
+   "source": [
+    "# Curious Account Creation\n",
+    "\n",
+    "1. Load file of IDs and passwords.\n",
+    "2. Invite each ID to applet.\n",
+    "3. Create an account for each ID using password from file.\n",
+    "4. As each account, log in and accept invitation."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "a7500f61-2e8c-4f08-ba11-6a2749fc4000",
+   "metadata": {
+    "microsoft": {
+     "language": "python",
+     "language_group": "jupyter_python"
+    }
+   },
+   "outputs": [],
+   "source": [
+    "from pathlib import Path\n",
+    "\n",
+    "from azure.identity import DefaultAzureCredential\n",
+    "from azure.keyvault.secrets import SecretClient\n",
+    "import httpx\n",
+    "import notebookutils\n",
+    "import polars as pl\n",
+    "\n",
+    "from curious_pyapi.api.curious import CuriousApiClient\n",
+    "from curious_pyapi.exceptions.exceptions import allow_existing\n",
+    "from curious_pyapi.schema.curious import CuriousId\n",
+    "from curious_pyapi.schema.pyapi import CuriousAuth\n",
+    "from curious_pyapi.utils.logging import get_logger\n",
+    "\n",
+    "conf = notebookutils.variableLibrary.getLibrary(\"ConfigurationVariables\")\n",
+    "\n",
+    "LOGGER = get_logger(__name__)\n",
+    "\n",
+    "APPLET_ID = conf.getVariable(\"AppletIdProlificMentalStateModelingStudy\")\n",
+    "EMAIL_FORMAT = \"msm+Z{}@childmind.org\"\n",
+    "TEMPORARY_NAME_FORMAT = \"_{}\"\n",
+    "\n",
+    "\n",
+    "def map_prolific_to_curious(df: pl.DataFrame, pl_namespace: str) -> pl.DataFrame:\n",
+    "    \"\"\"Transform a username-password DataFrame into a CuriousAccount DataFrame.\"\"\"\n",
+    "    record_id_str = pl.col(\"record_id\").cast(pl.String).str.zfill(6)\n",
+    "    match pl_namespace:\n",
+    "        case \"new_curious_user\":\n",
+    "            _name_expr = pl.format(TEMPORARY_NAME_FORMAT, record_id_str)\n",
+    "        case _:\n",
+    "            _name_expr = pl.lit(\"\")\n",
+    "\n",
+    "    return getattr(\n",
+    "        df.with_columns(\n",
+    "            email=pl.format(EMAIL_FORMAT, record_id_str),\n",
+    "            password=pl.col(\"password\").cast(pl.String),\n",
+    "            firstName=_name_expr,\n",
+    "            lastName=_name_expr,\n",
+    "            language=pl.lit(\"en\"),\n",
+    "            secretUserId=pl.col(\"record_id\").cast(pl.String),\n",
+    "            nickname=pl.col(\"record_id\").cast(pl.String),\n",
+    "            tag=pl.lit(\"Prolific\"),\n",
+    "        ),\n",
+    "        pl_namespace,\n",
+    "    ).enforce_schema()\n",
+    "\n",
+    "\n",
+    "def create_accounts_from_df(\n",
+    "    client: CuriousApiClient,\n",
+    "    df: pl.DataFrame,\n",
+    "    applet_id: CuriousId,\n",
+    "    user_type: str = \"respondent\",\n",
+    "    *,\n",
+    "    limit=None,\n",
+    ") -> None:\n",
+    "    \"\"\"For each row in DataFrame, create an account in Curious.\"\"\"\n",
+    "    invitations: dict[str, CuriousId] = {}\n",
+    "    api_df = map_prolific_to_curious(df, \"curious_account\")\n",
+    "    if limit:\n",
+    "        api_df = api_df.head(limit)\n",
+    "    for record in api_df.to_dicts():\n",
+    "        invitation = allow_existing(\n",
+    "            client.invite_user(applet_id=applet_id, user_type=user_type).post,\n",
+    "            json=record,\n",
+    "        )\n",
+    "        if invitation:\n",
+    "            invitation = invitation.json().get(\"result\")\n",
+    "        if not invitation:\n",
+    "            all_invitations = (\n",
+    "                client.invitations()\n",
+    "                .get(params={\"appletId\": applet_id, \"userType\": \"respondent\"})\n",
+    "                .json()\n",
+    "                .get(\"result\", [])\n",
+    "            )\n",
+    "            this_user_invitations = [\n",
+    "                i\n",
+    "                for i in all_invitations\n",
+    "                if all(\n",
+    "                    [\n",
+    "                        i.get(\"appletId\") == applet_id,\n",
+    "                        i.get(\"secretUserId\") == record[\"secretUserId\"],\n",
+    "                    ]\n",
+    "                )\n",
+    "            ]\n",
+    "            if this_user_invitations:\n",
+    "                invitation = this_user_invitations[0]\n",
+    "        if invitation and \"key\" in invitation:\n",
+    "            invitations[record[\"secretUserId\"]] = invitation[\"key\"]\n",
+    "    new_user_df = map_prolific_to_curious(df, \"new_curious_user\")\n",
+    "    for user in new_user_df.head(limit).to_dicts():\n",
+    "        response = allow_existing(client.user_create.post, json=user)\n",
+    "        secret_id = user[\"firstName\"][1:]\n",
+    "        if secret_id in invitations:\n",
+    "            user_client = CuriousApiClient(\n",
+    "                auth=CuriousAuth(\n",
+    "                    curious_email=user[\"email\"], curious_password=user[\"password\"]\n",
+    "                )\n",
+    "            )\n",
+    "            response = user_client.invitation_accept(key=invitations[secret_id]).post()\n",
+    "            if not httpx.codes.is_success(response.status_code):\n",
+    "                response.raise_for_status()\n",
+    "            del user_client"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "23eee694-1869-4893-9afe-6ef54c259090",
+   "metadata": {
+    "microsoft": {
+     "language": "python",
+     "language_group": "jupyter_python"
+    }
+   },
+   "outputs": [],
+   "source": [
+    "secret_client = SecretClient(\n",
+    "    vault_url=conf.getVariable(\"KeyVaultUri\"),\n",
+    "    credential=DefaultAzureCredential(),\n",
+    ")\n",
+    "admin_credentials = CuriousAuth(\n",
+    "    curious_email=secret_client.get_secret(\"CuriousEmail\").value,\n",
+    "    curious_password=secret_client.get_secret(\"CuriousPassword\").value,\n",
+    "    applet_id=APPLET_ID,\n",
+    "    applet_password=secret_client.get_secret(\"MsmProlificAppletPassword\").value,\n",
+    ")"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "426252e6-31f2-4091-b6a7-7fe5d7fa3c37",
+   "metadata": {
+    "microsoft": {
+     "language": "python",
+     "language_group": "synapse_pyspark"
+    },
+    "nteract": {
+     "transient": {
+      "deleting": false
+     }
+    }
+   },
+   "source": [
+    "## 1. Load file of IDs and passwords"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "1a55d086-9f84-491d-aeb5-d997df3557a9",
+   "metadata": {
+    "microsoft": {
+     "language": "python",
+     "language_group": "jupyter_python"
+    }
+   },
+   "outputs": [],
+   "source": [
+    "df = pl.read_excel(Path(\"Files/study_passwords.xlsx\"))\n",
+    "\"\"\"Raw DataFrame of IDs and passwords.\"\"\""
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "0f3b308c-dabc-42fa-9d6e-b11494dcc59a",
+   "metadata": {
+    "microsoft": {
+     "language": "python",
+     "language_group": "jupyter_python"
+    },
+    "nteract": {
+     "transient": {
+      "deleting": false
+     }
+    }
+   },
+   "source": [
+    "## 2‒4\n",
+    "### 2. Invite each ID to applet\n",
+    "### 3. Create an account for each ID using password from file.\n",
+    "### 4. As each account, log in and accept invitation."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "73f61305-9847-493f-af33-04787d3afecb",
+   "metadata": {
+    "microsoft": {
+     "language": "python",
+     "language_group": "jupyter_python"
+    }
+   },
+   "outputs": [],
+   "source": [
+    "admin_client = CuriousApiClient(auth=admin_credentials)\n",
+    "create_accounts_from_df(admin_client, df, applet_id=APPLET_ID)"
+   ]
+  }
+ ],
+ "metadata": {
+  "dependencies": {
+   "environment": {
+    "environmentId": "e11945f7-786a-451b-aeee-5ddebde287a4",
+    "workspaceId": "ea346909-a97e-43b1-b6ad-0670fd81ece4"
+   },
+   "lakehouse": {
+    "default_lakehouse": "cbe8c20b-e1f4-4b58-a6fa-f40541aade33",
+    "default_lakehouse_name": "MsmDevBronze",
+    "default_lakehouse_workspace_id": "879f45c2-2a52-471e-ab5b-abf825258afb",
+    "known_lakehouses": [
+     {
+      "id": "cbe8c20b-e1f4-4b58-a6fa-f40541aade33"
+     }
+    ]
+   }
+  },
+  "kernel_info": {
+   "jupyter_kernel_name": "python3.12",
+   "name": "jupyter"
+  },
+  "kernelspec": {
+   "display_name": "Jupyter",
+   "name": "jupyter"
+  },
+  "language_info": {
+   "name": "python"
+  },
+  "microsoft": {
+   "language": "python",
+   "language_group": "jupyter_python",
+   "ms_spell_check": {
+    "ms_spell_check_language": "en"
+   }
+  },
+  "nteract": {
+   "version": "nteract-front-end@1.0.0"
+  },
+  "spark_compute": {
+   "compute_id": "/trident/default",
+   "session_options": {
+    "conf": {
+     "spark.synapse.nbs.session.timeout": "1200000"
+    }
+   }
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 5
+}

{curious_pyapi-0.1.5 → curious_pyapi-0.1.7}/pyproject.toml

@@ -14,8 +14,8 @@ requires-python = ">=3.12"
 dependencies = [
     "fastexcel>=0.21.0",
     "httpx>=0.28.1",
-    "polars>=1.44.0",
-    "pydantic[email]>=2.13.4",
+    "polars>=1.44.1",
+    "pydantic[email]>=2.13.5",
 ]
 license-files = ["LICENSE"]
 license = "MIT"
@@ -46,7 +46,7 @@ reportUnknownMemberType = false
 
 [tool.ruff]
 line-length = 88
-target-version = "py314"
+target-version = "py312"
 
 [tool.ruff.lint]
 extend-select = ["A", "B904", "C4", "D", "E", "EM", "F541", "G", "I", "ICN", "LOG007", "N", "NPY", "PL", "RET", "RSE", "RUF", "Q", "T20", "TRY002", "TRY201", "TRY400", "TRY401", "UP032", "W"]

{curious_pyapi-0.1.5 → curious_pyapi-0.1.7}/uv.lock

@@ -47,8 +47,8 @@ dependencies = [
 requires-dist = [
     { name = "fastexcel", specifier = ">=0.21.0" },
     { name = "httpx", specifier = ">=0.28.1" },
-    { name = "polars", specifier = ">=1.44.0" },
-    { name = "pydantic", extras = ["email"], specifier = ">=2.13.4" },
+    { name = "polars", specifier = ">=1.44.1" },
+    { name = "pydantic", extras = ["email"], specifier = ">=2.13.5" },
 ]
 
 [[package]]