add .pth file

Author: rmorshea

idom_jupyter.pth

@@ -0,0 +1 @@
+import idom_jupyter

notebooks/introduction.ipynb

@@ -1,6 +1,7 @@
 {
  "cells": [
   {
+   "attachments": {},
    "cell_type": "markdown",
    "metadata": {},
    "source": [
@@ -13,55 +14,33 @@
     "\n",
     "# Getting Started\n",
     "\n",
-    "The first thing we need must do in order to run IDOM in a Jupyter Notebook is `import idom_jupyter`. After that, you'll be able to use IDOM components like any other [Jupyter Widget](https://ipywidgets.readthedocs.io/en/latest/#)."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 1,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "import idom_jupyter"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
+    "The first thing we need must do in order to run IDOM in a Jupyter Notebook is install `idom_jupyter` Jupyter with PIP:\n",
+    "\n",
+    "```bash\n",
+    "pip install idom-jupyter\n",
+    "```\n",
+    "\n",
+    "Once this is done you'll be able to use IDOM components like any other [Jupyter Widget](https://ipywidgets.readthedocs.io/en/latest/#).\n",
+    "\n",
     "# At a Glance\n",
     "\n",
     "To get a rough idea of how to write apps in IDOM, take a look at the tiny [“hello world”](https://en.wikipedia.org/wiki/%22Hello,_World!%22_program) application below:"
    ]
   },
   {
    "cell_type": "code",
-   "execution_count": 2,
+   "execution_count": 1,
    "metadata": {},
    "outputs": [
     {
      "data": {
       "text/plain": [
-       "App(7f911920b6a0)"
+       "App(7fe7b39a65c0)"
       ]
      },
-     "execution_count": 2,
+     "execution_count": 1,
      "metadata": {},
      "output_type": "execute_result"
-    },
-    {
-     "data": {
-      "application/vnd.jupyter.widget-view+json": {
-       "model_id": "14bfdffe5d5148b8bf923dc95fbfd788",
-       "version_major": 2,
-       "version_minor": 0
-      },
-      "text/plain": [
-       "LayoutWidget(Layout(App(7f911920b6a0)))"
-      ]
-     },
-     "metadata": {},
-     "output_type": "display_data"
     }
    ],
    "source": [

setup.py

@@ -1,6 +1,7 @@
 from __future__ import annotations
 
 from setuptools import setup, find_packages
+from setuptools.command.build_py import build_py
 from pathlib import Path
 
 from jupyter_packaging import (
@@ -102,12 +103,35 @@
     ),
 ]
 
-cmdclass = create_cmdclass("jsdeps", data_files_spec=data_files_spec)
-cmdclass["jsdeps"] = combine_commands(
-    install_npm(JS_DIR, npm=["yarn"], build_cmd="build:prod"),
-    ensure_targets(jstargets),
-)
-package["cmdclass"] = cmdclass
+package["cmdclass"] = {
+    **create_cmdclass("jsdeps", data_files_spec=data_files_spec),
+    "jsdeps": combine_commands(
+        install_npm(JS_DIR, npm=["yarn"], build_cmd="build:prod"),
+        ensure_targets(jstargets),
+    ),
+}
+
+# --------------------------------------------------------------------------------------
+# Build Pth File
+# --------------------------------------------------------------------------------------
+
+BuildPyBase: type[build_py] = package["cmdclass"]["build_py"]
+
+
+class BuildPy(BuildPyBase):
+    """Include the .pth file for this project, in the generated wheel."""
+
+    def run(self):
+        super().run()
+        pth_file = f"{NAME}.pth"
+        self.copy_file(
+            str(ROOT_DIR / pth_file),
+            str(Path(self.build_lib) / pth_file),
+            preserve_mode=0,
+        )
+
+
+package["cmdclass"] = {**package["cmdclass"], "build_py": BuildPy}
 
 # -----------------------------------------------------------------------------
 # Install It