basics of index

Author: jjmachan

nbs/index.ipynb

@@ -57,15 +57,57 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "First lets init a `Project` from notion."
+    "First do signup to [beta.app.ragas.io](https://beta.app.ragas.io/) and generate the App Token and put it in the as the env variable `RAGAS_APP_TOKEN`. "
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 1,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import os\n",
+    "# ideally you load this from a .env file so as to not commit it to the repo\n",
+    "os.environ[\"RAGAS_APP_TOKEN\"] = \"api-key\""
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "Now lets init a `Project` in the App"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from ragas_experimental import Project\n",
+    "\n",
+    "project = Project.create(\"my-project\")\n",
+    "project"
    ]
   }
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "python3",
+   "display_name": ".venv",
    "language": "python",
    "name": "python3"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.12.8"
   }
  },
  "nbformat": 4,