ssb-pubmd 0.0.3__py3-none-any.whl → 0.0.4__py3-none-any.whl

ssb_pubmd/__init__.py

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

ssb_pubmd/functions.py

@@ -5,33 +5,74 @@ https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html
 
 """
 
+import json
+import os
 
-def example_function(number1: int, number2: int) -> str:
-    """Compare two integers.
+import nbformat
+from nbformat import NotebookNode
 
-    This is merely an example function can be deleted. It is used to show and test generating
-    documentation from code, type hinting, testing, and testing examples
-    in the code.
 
+def _read_notebook(fp: str) -> NotebookNode:
+    return nbformat.read(fp, as_version=nbformat.NO_CONVERT)  # type: ignore
 
-    Args:
-        number1: The first number.
-        number2: The second number, which will be compared to number1.
 
-    Returns:
-        A string describing which number is the greatest.
+def notebook_to_cms(
+    notebook_filename: str,
+    endpoint: str,
+    notebook_folder: str = "",
+    display_name: str = "",
+) -> dict[str, str]:
+    r"""Sends all the markdown content of a notebook to a CMS endpoint.
 
-    Examples:
-        Examples should be written in doctest format, and should illustrate how
-        to use the function.
+    This function can be executed within the notebook it gets the markdown content from, \
+    but the notebook filename always has to be explicitly passed.
 
-        >>> example_function(1, 2)
-        1 is less than 2 by 1
+    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.
 
+    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*.
+
+    Args:
+        notebook_filename (str): The name of the notebook file.
+        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.
+        display_name (str): Send a custom *displayName* value to the CMS endpoint.
+
+    Returns:
+        (dict): The response from the CMS endpoint.
     """
-    if number1 < number2:
-        return f"{number1} is less than {number2} by {number2 - number1}"
-    elif number1 > number2:
-        return f"{number1} is greater than {number2} by {number1 - number2}"
+    if notebook_folder:
+        os.chdir(notebook_folder)
     else:
-        return f"{number1} is equal to {number2}"
+        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"
+        )
+
+    endpoint = endpoint
+
+    request_data = {"id": _id, "displayName": display_name, "markdown": markdown}
+
+    return request_data

{ssb_pubmd-0.0.3.dist-info → ssb_pubmd-0.0.4.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: ssb-pubmd
-Version: 0.0.3
+Version: 0.0.4
 Summary: SSB Pubmd
 License: MIT
 Author: Olav Landsverk
@@ -14,6 +14,7 @@ Classifier: Programming Language :: Python :: 3.11
 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)
 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.dist-info/RECORD

@@ -0,0 +1,9 @@
+ssb_pubmd/__init__.py,sha256=GGdFjb7Gcazu5sC97C-Je8JY-8f0dZ6mKjL-G-4cJLo,88
+ssb_pubmd/__main__.py,sha256=8D0yedPhnV_2L7nj0s0KUKxNQqPxoussMHGDNM-vyjg,209
+ssb_pubmd/functions.py,sha256=UgNVKehv9ULKVJKcZt-zGBIcPUetD1Iy9Q9kJurj7BI,2591
+ssb_pubmd/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+ssb_pubmd-0.0.4.dist-info/LICENSE,sha256=tF5bnYv09fgH5ph9t1EpH1MGrVOGTQeswL4dzVeZ_ak,1073
+ssb_pubmd-0.0.4.dist-info/METADATA,sha256=tGKSsJpSglhxqSIhDrepOCU6aVXRiR_3z_YLd3-guDE,3782
+ssb_pubmd-0.0.4.dist-info/WHEEL,sha256=XbeZDeTWKc1w7CSIyre5aMDU_-PohRwTQceYnisIYYY,88
+ssb_pubmd-0.0.4.dist-info/entry_points.txt,sha256=o4oU99zbZNIBKGYWdgdEG6ev-62ZRWEJOe7EOjJaajk,53
+ssb_pubmd-0.0.4.dist-info/RECORD,,

ssb_pubmd-0.0.3.dist-info/RECORD

@@ -1,9 +0,0 @@
-ssb_pubmd/__init__.py,sha256=kCA0PilWSQNDZh4rUo5jRghGfLkmQkZDcWMNRJSQVaA,17
-ssb_pubmd/__main__.py,sha256=8D0yedPhnV_2L7nj0s0KUKxNQqPxoussMHGDNM-vyjg,209
-ssb_pubmd/functions.py,sha256=liG4j8_NaA1NGGZGqqDcexaOSUQmR9Ksbk7xa253O94,1122
-ssb_pubmd/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-ssb_pubmd-0.0.3.dist-info/LICENSE,sha256=tF5bnYv09fgH5ph9t1EpH1MGrVOGTQeswL4dzVeZ_ak,1073
-ssb_pubmd-0.0.3.dist-info/METADATA,sha256=F33kVdLp4H2Jt4Oj4cMzCWhkydj01L47d0XnCnHf4wU,3740
-ssb_pubmd-0.0.3.dist-info/WHEEL,sha256=XbeZDeTWKc1w7CSIyre5aMDU_-PohRwTQceYnisIYYY,88
-ssb_pubmd-0.0.3.dist-info/entry_points.txt,sha256=o4oU99zbZNIBKGYWdgdEG6ev-62ZRWEJOe7EOjJaajk,53
-ssb_pubmd-0.0.3.dist-info/RECORD,,