Fix CI update converter notebooks to not write to home directory

Author: braingram

.github/workflows/ci.yml

@@ -8,8 +8,8 @@ on:
     branches:
       - main
   pull_request:
-    types:
-      - synchronize
+    branches:
+      - main
 
 
 # Only cancel in-progress jobs or runs for the current workflow

notebooks/Your_first_ASDF_converter.ipynb

@@ -102,79 +102,6 @@
     "leave it be."
    ]
   },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "5fec10da",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "mkdir ~/converter_tutorial"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "3b1e163f",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "cd ~/converter_tutorial"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "06a42933",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "# Record current directory for restarts\n",
-    "import os\n",
-    "curdir = os.getcwd()\n",
-    "print(curdir)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "0ae4a184",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "mkdir mfconverter"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "46d22a46",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "cd mfconverter"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "a980c3f9",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "mkdir src"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "8dbb76d3",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "mkdir src/mfconverter"
-   ]
-  },
   {
    "cell_type": "markdown",
    "id": "ede348bd",
@@ -183,38 +110,6 @@
     "And now we will create a module that has a very, very simple photo ID class and add a package `__init__.py`"
    ]
   },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "f045f111",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "%%writefile src/mfconverter/photo_id.py\n",
-    "class PhotoID:\n",
-    "    \"Holds Photo ID information\"\n",
-    "\n",
-    "    def __init__(self, last_name, first_name, photo):\n",
-    "        \"expects a monochromatic numpy array for photo\"\n",
-    "        self.last_name = last_name\n",
-    "        self.first_name = first_name\n",
-    "        self.photo = photo\n",
-    "    \n",
-    "    def name(self):\n",
-    "        return self.last_name + ', ' + self.first_name"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "ad205d2e",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "%%writefile src/__init__.py\n",
-    "\n"
-   ]
-  },
   {
    "cell_type": "markdown",
    "id": "09ee1385",
@@ -223,40 +118,6 @@
     "Next we create the file that contains the converter code"
    ]
   },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "aa345e79",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "%%writefile src/mfconverter/converter.py\n",
-    "from asdf.extension import Converter\n",
-    "\n",
-    "class PhotoIDConverter(Converter):\n",
-    "    tags = [\"asdf://stsci.edu/example-project/tags/photo_id-*\"]\n",
-    "    types = [\"mfconverter.photo_id.PhotoID\"]\n",
-    "    # The above registers the tag that the converter is used for, as well as\n",
-    "    # associating the class that the converter is used for.\n",
-    "    \n",
-    "    # This method converts from the Python object to yaml\n",
-    "    def to_yaml_tree(self, obj, tags, ctx):\n",
-    "        # The yaml conversion expects a dictionary returned\n",
-    "        node = {}\n",
-    "        node['first_name'] = obj.first_name\n",
-    "        node['last_name'] = obj.last_name\n",
-    "        node['photo'] = obj.photo\n",
-    "        return node\n",
-    "    \n",
-    "    # This method converts from yaml to the Python object\n",
-    "    def from_yaml_tree(self, node, tag, ctx):\n",
-    "        from .photo_id import PhotoID # Deferred import to avoid always importing \n",
-    "                                      # when ASDF gets entry points.\n",
-    "        return PhotoID(node['last_name'],\n",
-    "                       node['first_name'],\n",
-    "                       node['photo'])"
-   ]
-  },
   {
    "cell_type": "markdown",
    "id": "55ca30cd",
@@ -278,27 +139,6 @@
     "We need to create a module for the entry point handling"
    ]
   },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "f9c03910",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "%%writefile src/mfconverter/extensions.py\n",
-    "from asdf.extension import Extension\n",
-    "from .converter import PhotoIDConverter\n",
-    "\n",
-    "class MFExtension(Extension):\n",
-    "    extension_uri = \"asdf://stsci.edu/example-project/photo_id-1.0.0\"\n",
-    "    tags = [\"asdf://stsci.edu/example-project/tags/photo_id-1.0.0\"]\n",
-    "    converters = [PhotoIDConverter()]\n",
-    "\n",
-    "# The following will be called by ASDF when looking for ASDF entry points    \n",
-    "def get_extensions():\n",
-    "    return [MFExtension()]"
-   ]
-  },
   {
    "cell_type": "markdown",
    "id": "412c3e4f",
@@ -307,37 +147,6 @@
     "And finally, the entry point reference in setup.cfg, provided here as a whole file."
    ]
   },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "feb206d7",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "%%writefile pyproject.toml\n",
-    "[project]\n",
-    "name = \"mfconverter\"\n",
-    "description = \"TODO\"\n",
-    "version='0.1.0'\n",
-    "requires-python = \">=3.9\"\n",
-    "dependencies = [\n",
-    "    \"jsonschema >=3.0.2\",\n",
-    "    \"asdf >=2.8\",\n",
-    "    \"psutil >=5.7.2\",\n",
-    "    \"numpy>=1.16\",\n",
-    "]\n",
-    "\n",
-    "[build-system]\n",
-    "requires = [\"setuptools >=61\", \"setuptools_scm[toml] >=3.4\"]\n",
-    "build-backend = \"setuptools.build_meta\"\n",
-    "\n",
-    "[project.entry-points.\"asdf.extensions\"]\n",
-    "mfconverter = \"mfconverter.extensions:get_extensions\"\n",
-    "\n",
-    "[tool.setuptools.packages.find]\n",
-    "where = [\"src\"]"
-   ]
-  },
   {
    "cell_type": "markdown",
    "id": "8d0e3882",
@@ -349,33 +158,13 @@
     "We need the setup.py file too"
    ]
   },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "3ffb22d6",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "%%writefile setup.py\n",
-    "#!/usr/bin/env python3\n",
-    "from setuptools import setup\n",
-    "\n",
-    "setup()"
-   ]
-  },
   {
    "cell_type": "markdown",
    "id": "b7628aaa",
    "metadata": {},
    "source": [
     "Install package\n",
-    "------------------\n",
-    "\n",
-    "This is best done from a terminal window using the command\n",
-    "\n",
-    "`pip install --editable .`\n",
-    "\n",
-    "But this notebook will do that, but a consequence is that if the reinstallation must be done, the Jupyter kernel must be restarted to pick up the new installation."
+    "------------------"
    ]
   },
   {
@@ -385,7 +174,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "!pip install --editable ."
+    "!pip install ./Your_first_ASDF_converter"
    ]
   },
   {
@@ -539,7 +328,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.10.10"
+   "version": "3.13.4"
   }
  },
  "nbformat": 4,

notebooks/Your_first_ASDF_converter/pyproject.toml

@@ -0,0 +1,18 @@
+[project]
+name = "mfconverter"
+description = "TODO"
+version='0.1.0'
+requires-python = ">=3.9"
+dependencies = [
+    "asdf >=2.8",
+]
+
+[build-system]
+requires = ["setuptools >=61", "setuptools_scm[toml] >=3.4"]
+build-backend = "setuptools.build_meta"
+
+[project.entry-points."asdf.extensions"]
+mfconverter = "mfconverter.extensions:get_extensions"
+
+[tool.setuptools.packages.find]
+where = ["src"]

notebooks/Your_first_ASDF_converter/src/mfconverter/__init__.py

@@ -0,0 +1,24 @@
+from asdf.extension import Converter
+
+class PhotoIDConverter(Converter):
+    tags = ["asdf://stsci.edu/example-project/tags/photo_id-*"]
+    types = ["mfconverter.photo_id.PhotoID"]
+    # The above registers the tag that the converter is used for, as well as
+    # associating the class that the converter is used for.
+
+    # This method converts from the Python object to yaml
+    def to_yaml_tree(self, obj, tags, ctx):
+        # The yaml conversion expects a dictionary returned
+        node = {}
+        node['first_name'] = obj.first_name
+        node['last_name'] = obj.last_name
+        node['photo'] = obj.photo
+        return node
+
+    # This method converts from yaml to the Python object
+    def from_yaml_tree(self, node, tag, ctx):
+        from .photo_id import PhotoID # Deferred import to avoid always importing 
+                                      # when ASDF gets entry points.
+        return PhotoID(node['last_name'],
+                       node['first_name'],
+                       node['photo'])

notebooks/Your_first_ASDF_converter/src/mfconverter/converter.py

@@ -0,0 +1,11 @@
+from asdf.extension import Extension
+from .converter import PhotoIDConverter
+
+class MFExtension(Extension):
+    extension_uri = "asdf://stsci.edu/example-project/photo_id-1.0.0"
+    tags = ["asdf://stsci.edu/example-project/tags/photo_id-1.0.0"]
+    converters = [PhotoIDConverter()]
+
+# The following will be called by ASDF when looking for ASDF entry points    
+def get_extensions():
+    return [MFExtension()]

notebooks/Your_first_ASDF_converter/src/mfconverter/extensions.py

@@ -0,0 +1,11 @@
+class PhotoID:
+    "Holds Photo ID information"
+
+    def __init__(self, last_name, first_name, photo):
+        "expects a monochromatic numpy array for photo"
+        self.last_name = last_name
+        self.first_name = first_name
+        self.photo = photo
+
+    def name(self):
+        return self.last_name + ', ' + self.first_name