edsl 0.1.27.dev2__py3-none-any.whl → 0.1.27.dev3__py3-none-any.whl

edsl/__init__.py

@@ -35,4 +35,5 @@ from edsl.data.CacheEntry import CacheEntry
 from edsl.data.CacheHandler import set_session_cache, unset_session_cache
 from edsl.shared import shared_globals
 from edsl.jobs import Jobs
+from edsl.notebooks import Notebook
 from edsl.coop.coop import Coop

edsl/__version__.py

@@ -1 +1 @@
-__version__ = "0.1.27.dev2"
+__version__ = "0.1.27.dev3"

edsl/notebooks/Notebook.py

@@ -1,5 +1,8 @@
 """A Notebook is ...."""
 
+import json
+import nbformat
+
 from typing import Dict, List, Optional
 from rich.table import Table
 from edsl.Base import Base
@@ -14,22 +17,33 @@ class Notebook(Base):
     A Notebook is a utility class that allows you to easily share/pull ipynbs from Coop.
     """
 
-    def __init__(self, data: Optional[Dict] = None, path: Optional[str] = None):
+    default_name = "notebook"
+
+    def __init__(
+        self,
+        data: Optional[Dict] = None,
+        path: Optional[str] = None,
+        name: Optional[str] = None,
+    ):
         """
         Initialize a new Notebook.
         - if a path is provided, try to load the notebook from that path.
         - if no path is provided, assume this code is run in a notebook and try to load the current notebook.
         """
         if data is not None:
+            nbformat.validate(data)
             self.data = data
         elif path is not None:
             # TO BE IMPLEMENTED
             # store in this var the data from the notebook
-            self.data = {"some": "data"}
+            with open(path, mode="r", encoding="utf-8") as f:
+                data = nbformat.read(f, as_version=4)
+            self.data = json.loads(json.dumps(data))
         else:
             # TO BE IMPLEMENTED
             # 1. Check you're in a notebook ...
             # 2. get its info and store it in self.data
+            # RI: Working on this
             self.data = {"some": "data"}
 
         # deprioritize - perhaps add sanity check function
@@ -37,9 +51,12 @@ class Notebook(Base):
         # 2. could check notebook uses EDSL
         # ....
 
+        self.name = name or self.default_name
+
     def __eq__(self, other):
         """
         Check if two Notebooks are equal.
+        This should maybe only check the cells and not the metadata/nbformat?
         """
         return self.data == other.data
 
@@ -50,7 +67,7 @@ class Notebook(Base):
         AF: here you will create a dict from which self.from_dict can recreate the object.
         AF: the decorator will add the edsl_version to the dict.
         """
-        return {"data": self.data}
+        return {"name": self.name, "data": self.data}
 
     @classmethod
     @remove_edsl_version
@@ -58,7 +75,15 @@ class Notebook(Base):
         """
         Convert a dictionary representation of a Notebook to a Notebook object.
         """
-        return cls(data=d["data"])
+        return cls(data=d["data"], name=d["name"])
+
+    def to_file(self, path: str):
+        """
+        Saves the notebook at the specified filepath.
+        RI: Maybe you want to download a notebook to your local machine
+        to work with it?
+        """
+        nbformat.write(nbformat.from_dict(self.data), fp=path)
 
     def print(self):
         """
@@ -96,7 +121,33 @@ class Notebook(Base):
         Return an example Notebook.
         AF: add a simple custom example here
         """
-        return cls(data={"some": "data"})
+        cells = [
+            {
+                "cell_type": "markdown",
+                "metadata": dict(),
+                "source": "# Test notebook",
+            },
+            {
+                "cell_type": "code",
+                "execution_count": 1,
+                "metadata": dict(),
+                "outputs": [
+                    {
+                        "name": "stdout",
+                        "output_type": "stream",
+                        "text": "Hello world!\n",
+                    }
+                ],
+                "source": 'print("Hello world!")',
+            },
+        ]
+        data = {
+            "metadata": dict(),
+            "nbformat": 4,
+            "nbformat_minor": 4,
+            "cells": cells,
+        }
+        return cls(data=data)
 
     def code(self) -> List[str]:
         """
@@ -104,8 +155,8 @@ class Notebook(Base):
         AF: Again, not sure
         """
         lines = []
-        lines.append("from edsl.notebooks import Notebook")
-        lines.append(f"s = Notebook({self.data})")
+        lines.append("from edsl import Notebook")
+        lines.append(f"nb = Notebook(data={self.data}, name='{self.name}')")
         return lines
 
 

{edsl-0.1.27.dev2.dist-info → edsl-0.1.27.dev3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: edsl
-Version: 0.1.27.dev2
+Version: 0.1.27.dev3
 Summary: Create and analyze LLM-based surveys
 Home-page: https://www.expectedparrot.com/
 License: MIT

{edsl-0.1.27.dev2.dist-info → edsl-0.1.27.dev3.dist-info}/RECORD

@@ -1,6 +1,6 @@
 edsl/Base.py,sha256=IlWEjQTnKbSPm9xqUqE7D6izBDnzARbrV_NHd7YJGeY,6601
-edsl/__init__.py,sha256=7UsuBUVcdmaz6je-0D1HvPG6X3ATtXud_hYpUrkU6H0,1182
-edsl/__version__.py,sha256=T8ew6f9SFqYwIN50vSD5-4mUOKle1OES4cRWdaZmtng,28
+edsl/__init__.py,sha256=b1rnUg4e_MA87LDuDeAZkS7h-DHdtB8h3UYQCgzdSgQ,1218
+edsl/__version__.py,sha256=GX6Byw31fnUBfUiG4GIYMexAOcvuVVuIA9WDTEX5_34,28
 edsl/agents/Agent.py,sha256=sPtYxD3ZJ3CqpsPV0nP0MaaqItqRTT787mcwtmxOrzg,25536
 edsl/agents/AgentList.py,sha256=CceqVJ-4sMJgOZ9YFODOaW-1hIthbMeNgi1NIbiiLuQ,7045
 edsl/agents/Invigilator.py,sha256=slNz5LTRAB53_DDhgR1WxU-6kBHivJZ6iNloGlLRSGs,10223
@@ -81,7 +81,7 @@ edsl/language_models/__init__.py,sha256=bvY7Gy6VkX1gSbNkRbGPS-M1kUnb0EohL0FSagaE
 edsl/language_models/registry.py,sha256=vUJIS89lJXg5OIlz7dq32SEOL7-OI6pRbTGE-2QRicM,2758
 edsl/language_models/repair.py,sha256=YJYo_PXrbqqOLB_lWYL4RQ0X2nYozl9IycYUi6rueLU,3336
 edsl/language_models/unused/ReplicateBase.py,sha256=J1oqf7mEyyKhRwNUomnptVqAsVFYCbS3iTW0EXpKtXo,3331
-edsl/notebooks/Notebook.py,sha256=m9ym0PYff_NrW3MHEWGLPelEfMU2TSA9gTKlnsCU4hI,3339
+edsl/notebooks/Notebook.py,sha256=TkxEDPu0nvCWLfiWxOEmZP_P10SSovRyQWFwHvtDXuk,4851
 edsl/notebooks/__init__.py,sha256=VNUA3nNq04slWNbYaNrzOhQJu3AZANpvBniyCJSzJ7U,45
 edsl/prompts/Prompt.py,sha256=LIfM5RwnhyJFOAmVdd5GlgMtJNWcMjG0TszMTJfidFc,9554
 edsl/prompts/QuestionInstructionsBase.py,sha256=xico6ob4cqWsHl-txj2RbY_4Ny5u9UqvIjmoTVgjUhk,348
@@ -166,7 +166,7 @@ edsl/utilities/decorators.py,sha256=rlTSMItwmWUxHQBIEUDxX3lFzgtiT8PnfNavakuf-2M,
 edsl/utilities/interface.py,sha256=GxEDMxmpnyxcy71yzdDNqdoh7GLrDEbTD0y9M81ZkZk,19084
 edsl/utilities/restricted_python.py,sha256=5-_zUhrNbos7pLhDl9nr8d24auRlquR6w-vKkmNjPiA,2060
 edsl/utilities/utilities.py,sha256=YLzbA3kBFisy8fWpodrwi-CsKlMhbUwZ89RYyCNRq4Q,8708
-edsl-0.1.27.dev2.dist-info/LICENSE,sha256=_qszBDs8KHShVYcYzdMz3HNMtH-fKN_p5zjoVAVumFc,1111
-edsl-0.1.27.dev2.dist-info/METADATA,sha256=sQ3Mop8YapjdD9dMvfvwpMOc6PmlC8QkwrMNlY7ObEc,3128
-edsl-0.1.27.dev2.dist-info/WHEEL,sha256=FMvqSimYX_P7y0a7UY-_Mc83r5zkBZsCYPm7Lr0Bsq4,88
-edsl-0.1.27.dev2.dist-info/RECORD,,
+edsl-0.1.27.dev3.dist-info/LICENSE,sha256=_qszBDs8KHShVYcYzdMz3HNMtH-fKN_p5zjoVAVumFc,1111
+edsl-0.1.27.dev3.dist-info/METADATA,sha256=EW5J1nGaPZzzXUqB-iF9-zQoLEB5_23vhUtjnptld58,3128
+edsl-0.1.27.dev3.dist-info/WHEEL,sha256=FMvqSimYX_P7y0a7UY-_Mc83r5zkBZsCYPm7Lr0Bsq4,88
+edsl-0.1.27.dev3.dist-info/RECORD,,