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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: ssb-pubmd
-Version: 0.0.3
+Version: 0.0.5
 Summary: SSB Pubmd
 License: MIT
 Author: Olav Landsverk
@@ -14,6 +14,9 @@ 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)
+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.3 → ssb_pubmd-0.0.5}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "ssb-pubmd"
-version = "0.0.3"
+version = "0.0.5"
 description = "SSB Pubmd"
 authors = ["Olav Landsverk <stud-oll@ssb.no>"]
 license = "MIT"
@@ -16,6 +16,9 @@ Changelog = "https://github.com/statisticsnorway/ssb-pubmd/releases"
 [tool.poetry.dependencies]
 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.5/src/ssb_pubmd/__init__.py

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

ssb_pubmd-0.0.5/src/ssb_pubmd/functions.py

@@ -0,0 +1,79 @@
+"""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 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)
+
+    return json.dumps(response, indent=4)

ssb_pubmd-0.0.3/src/ssb_pubmd/__init__.py

@@ -1 +0,0 @@
-"""SSB Pubmd."""

ssb_pubmd-0.0.3/src/ssb_pubmd/functions.py

@@ -1,37 +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
-
-"""
-
-
-def example_function(number1: int, number2: int) -> str:
-    """Compare two integers.
-
-    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.
-
-
-    Args:
-        number1: The first number.
-        number2: The second number, which will be compared to number1.
-
-    Returns:
-        A string describing which number is the greatest.
-
-    Examples:
-        Examples should be written in doctest format, and should illustrate how
-        to use the function.
-
-        >>> example_function(1, 2)
-        1 is less than 2 by 1
-
-    """
-    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}"
-    else:
-        return f"{number1} is equal to {number2}"