ssb-pubmd 0.0.6__tar.gz → 0.0.8__tar.gz

{ssb_pubmd-0.0.6 → ssb_pubmd-0.0.8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: ssb-pubmd
-Version: 0.0.6
+Version: 0.0.8
 Summary: SSB Pubmd
 License: MIT
 Author: Olav Landsverk

{ssb_pubmd-0.0.6 → ssb_pubmd-0.0.8}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "ssb-pubmd"
-version = "0.0.6"
+version = "0.0.8"
 description = "SSB Pubmd"
 authors = ["Olav Landsverk <stud-oll@ssb.no>"]
 license = "MIT"
@@ -38,6 +38,8 @@ sphinx-click = ">=3.0.2"
 typeguard = ">=2.13.3"
 xdoctest = { extras = ["colors"], version = ">=0.15.10" }
 myst-parser = { version = ">=0.16.1" }
+uuid = "^1.30"
+ipykernel = "^6.29.5"
 
 [tool.pytest.ini_options]
 pythonpath = ["src"]

{ssb_pubmd-0.0.6 → ssb_pubmd-0.0.8}/src/ssb_pubmd/__init__.py

@@ -1,5 +1,5 @@
 """SSB Pubmd."""
 
-from .functions import notebook_to_cms
+from .exporter import notebook_to_cms
 
 __all__ = ["notebook_to_cms"]

ssb_pubmd-0.0.8/src/ssb_pubmd/exporter.py

@@ -0,0 +1,140 @@
+import json
+import os
+
+import nbformat
+import requests
+from nbformat import NotebookNode
+
+
+class _Exporter:
+    """Helper class for exporting notebook content."""
+
+    ID_KEY = "_id"
+
+    def __init__(self, post_url: str) -> None:
+        self.post_url: str = post_url
+        self.notebook_folder: str = ""
+        self.notebook_filename: str = ""
+
+    @property
+    def parent_folder(self) -> str:
+        """The parent folder path, defaults to current working directory."""
+        if self.notebook_folder:
+            return self.notebook_folder
+        else:
+            return os.getcwd()
+
+    @property
+    def notebook_path(self) -> str:
+        """The absolute path of the notebook file."""
+        return os.path.join(self.parent_folder, self.notebook_filename)
+
+    @property
+    def basename(self) -> str:
+        """The name of the notebook file without extension."""
+        return os.path.splitext(self.notebook_filename)[0]
+
+    @property
+    def data_path(self) -> str:
+        """The absolute path of the file to store data returned from the CMS."""
+        return os.path.join(self.parent_folder, self.basename + ".json")
+
+    @property
+    def display_name(self) -> str:
+        """Generate a display name for the content."""
+        return self.basename.replace("_", " ").title()
+
+    def _save_content_id(self, content_id: str) -> None:
+        """Saves the content id to the data file."""
+        filename = self.data_path
+        with open(filename, "w") as file:
+            json.dump({self.ID_KEY: content_id}, file)
+
+    def _get_content_id(self) -> str:
+        """Returns the content id from the data file if it exists, otherwise an empty string."""
+        content_id = ""
+
+        filename = self.data_path
+        if os.path.exists(filename):
+            with open(filename) as file:
+                content_id = json.load(file)[self.ID_KEY]
+        return content_id
+
+    def _read_notebook(self) -> NotebookNode:
+        """Reads the notebook file and returns its content."""
+        return nbformat.read(self.notebook_path, as_version=nbformat.NO_CONVERT)  # type: ignore
+
+    def _get_content_from_notebook(self) -> str:
+        """Extracts all markdown cells from the notebook and returns it as a merged string."""
+        notebook = self._read_notebook()
+
+        markdown_cells = []
+        for cell in notebook.cells:
+            if cell.cell_type == "markdown":
+                markdown_cells.append(cell.source)
+
+        markdown_content = "\n\n".join(markdown_cells)
+
+        return markdown_content
+
+    def _request_data(self) -> dict[str, str]:
+        """Prepares the request data to be sent to the CMS post_url."""
+        return {
+            "_id": self._get_content_id(),
+            "displayName": self.display_name,
+            "markdown": self._get_content_from_notebook(),
+        }
+
+    def _send_request(self) -> str:
+        """Sends the request to the CMS endpoint and returns the content id from the response."""
+        response = requests.post(
+            self.post_url,
+            data=self._request_data(),
+        )
+        content_id = response.json()[self.ID_KEY]
+        return content_id  # type: ignore
+
+    def set_notebook(self, notebook_filename: str, notebook_folder: str) -> None:
+        """Sets the notebook filename and notebook folder."""
+        self.notebook_filename = notebook_filename
+        self.notebook_folder = notebook_folder
+
+    def export(self) -> str:
+        """Main method to export the notebook content to the CMS post_url."""
+        content_id = self._send_request()
+        self._save_content_id(content_id)
+        return content_id
+
+
+def notebook_to_cms(
+    post_url: str,
+    notebook_filename: str,
+    notebook_folder: str = "",
+) -> str:
+    r"""Sends all the markdown content of a notebook to a CMS endpoint.
+
+    The CMS endpoint must satisfy two constraints:
+
+    -   It must accept a post request with fields *_id*, *displayName* and *markdown*.
+    -   The response body must have a key *_id* whose value should be
+        a unique string identifier of the content.
+
+    Creating and updating content is handled in the following way:
+
+    -   On the first request, an empty string is sent as *id*.
+    -   If the request succeeds, the value of *_id* (in the response) is stored in a JSON file
+        (created in the same directory as the notebook file).
+    -   On subsequent requests, the stored value is sent as *id*.
+
+    Args:
+        post_url (str): The URL of the CMS endpoint.
+        notebook_filename (str): The name of the notebook file, e.g. `"my_notebook.ipynb"`.
+        notebook_folder (str): Sets a custom notebook folder (as absolute path) containing the notebook file.
+            If not set, the current folder is used.
+
+    Returns:
+        str: The identifier of the content returned by the CMS endpoint.
+    """
+    exporter = _Exporter(post_url)
+    exporter.set_notebook(notebook_filename, notebook_folder)
+    return exporter.export()

ssb_pubmd-0.0.6/src/ssb_pubmd/functions.py

@@ -1,85 +0,0 @@
-"""A collection of useful functions.
-
-The template and this example uses Google style docstrings as described at:
-https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html
-
-"""
-
-import json
-import os
-
-import nbformat
-import requests
-from nbformat import NotebookNode
-
-
-def _read_notebook(fp: str) -> NotebookNode:
-    return nbformat.read(fp, as_version=nbformat.NO_CONVERT)  # type: ignore
-
-
-def notebook_to_cms(
-    notebook_filename: str,
-    endpoint: str,
-    notebook_folder: str = "",
-    display_name: str = "",
-) -> str:
-    r"""Sends all the markdown content of a notebook to a CMS endpoint.
-
-    The CMS endpoint must satisfy two constraints:
-
-    -   It must accept a post request with fields *id*, *displayName* and *markdown*.
-    -   The response body must have a key *_id* whose value should be
-        a unique string identifier of the content.
-
-    Creating and updating content is handled in the following way:
-
-    -   On the first request, an empty string is sent as *id*.
-    -   If the request succeeds, the value of *_id* (in the response) is stored in a JSON file
-        (created in the same directory as the notebook file).
-    -   On subsequent requests, the stored value is sent as *id*.
-
-    Args:
-        notebook_filename (str): The name of the notebook file, e.g. `"my_notebook.ipynb"`.
-        endpoint (str): The URL of the CMS endpoint.
-        notebook_folder (str): Sets a custom notebook folder (as absolute path) containing the notebook file.
-            If not set, the current folder is used.
-        display_name (str): Send a custom *displayName* value to the CMS endpoint.
-            If not set, the notebook filename is used (with the file extension removed,
-            underscores replaced with spaces, and words capitalized).
-
-    Returns:
-        str: The body of the response from the CMS endpoint, string-formatted.
-    """
-    if notebook_folder:
-        os.chdir(notebook_folder)
-    else:
-        os.chdir(os.getcwd())
-
-    basename = os.path.splitext(notebook_filename)[0]
-    json_filename = basename + ".json"
-
-    _id = ""
-    if os.path.exists(json_filename):
-        with open(json_filename) as file:
-            _id = json.load(file)["_id"]
-
-    if not display_name:
-        display_name = basename.replace("_", " ").title()
-
-    markdown = ""
-    if os.path.exists(notebook_filename):
-        notebook = _read_notebook(notebook_filename)
-        markdown = "\n\n".join(
-            cell.source for cell in notebook.cells if cell.cell_type == "markdown"
-        )
-
-    request_data = {"_id": _id, "displayName": display_name, "markdown": markdown}
-    response = requests.post(endpoint, data=request_data)
-
-    body = response.json()
-    node_id = body.get("_id")
-
-    with open(json_filename, "w") as file:
-        json.dump({"_id": node_id}, file)
-
-    return json.dumps(body, indent=4)