ssb-pubmd 0.0.4__tar.gz → 0.0.5__tar.gz

{ssb_pubmd-0.0.4 → ssb_pubmd-0.0.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: ssb-pubmd
-Version: 0.0.4
+Version: 0.0.5
 Summary: SSB Pubmd
 License: MIT
 Author: Olav Landsverk
@@ -15,6 +15,8 @@ Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Requires-Dist: click (>=8.0.1)
 Requires-Dist: nbformat (>=5.10.4,<6.0.0)
+Requires-Dist: requests (>=2.32.3,<3.0.0)
+Requires-Dist: types-requests (>=2.32.0.20250306,<3.0.0.0)
 Project-URL: Changelog, https://github.com/statisticsnorway/ssb-pubmd/releases
 Project-URL: Documentation, https://statisticsnorway.github.io/ssb-pubmd
 Project-URL: Homepage, https://github.com/statisticsnorway/ssb-pubmd

{ssb_pubmd-0.0.4 → ssb_pubmd-0.0.5}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "ssb-pubmd"
-version = "0.0.4"
+version = "0.0.5"
 description = "SSB Pubmd"
 authors = ["Olav Landsverk <stud-oll@ssb.no>"]
 license = "MIT"
@@ -17,6 +17,8 @@ Changelog = "https://github.com/statisticsnorway/ssb-pubmd/releases"
 python = "^3.10"
 click = ">=8.0.1"
 nbformat = "^5.10.4"
+requests = "^2.32.3"
+types-requests = "^2.32.0.20250306"
 
 [tool.poetry.group.dev.dependencies]
 pygments = ">=2.10.0"

{ssb_pubmd-0.0.4 → ssb_pubmd-0.0.5}/src/ssb_pubmd/functions.py

@@ -9,6 +9,7 @@ import json
 import os
 
 import nbformat
+import requests
 from nbformat import NotebookNode
 
 
@@ -21,32 +22,33 @@ def notebook_to_cms(
     endpoint: str,
     notebook_folder: str = "",
     display_name: str = "",
-) -> dict[str, str]:
+) -> str:
     r"""Sends all the markdown content of a notebook to a CMS endpoint.
 
-    This function can be executed within the notebook it gets the markdown content from, \
-    but the notebook filename always has to be explicitly passed.
+    The CMS endpoint must satisfy two constraints:
 
-    The CMS endpoint has to satisfy two constraints:
-    * It must accept post requests with fields *id*, *displayName* and *markdown*.
-    * The response body must have a key *_id* whose value should be \
-    the unique identifier of the created content in the CMS.
+    -   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.
 
-    On the first successfull request, an empty string is sent as *id*,
-    and the *_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*.
+    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.
+        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): Ignore this parameter when executing the function from \
-        the notebook containing the markdown content. \
-        Sets a custom base directory (absolute path) containing the notebook file.
+        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:
-        (dict): The response from the CMS endpoint.
+        str: The response from the CMS endpoint, string-formatted.
     """
     if notebook_folder:
         os.chdir(notebook_folder)
@@ -71,8 +73,7 @@ def notebook_to_cms(
             cell.source for cell in notebook.cells if cell.cell_type == "markdown"
         )
 
-    endpoint = endpoint
-
     request_data = {"id": _id, "displayName": display_name, "markdown": markdown}
+    response = requests.post(endpoint, data=request_data)
 
-    return request_data
+    return json.dumps(response, indent=4)