labstep 3.28.0__tar.gz → 3.28.2__tar.gz

{labstep-3.28.0 → labstep-3.28.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: labstep
-Version: 3.28.0
+Version: 3.28.2
 Summary: Python SDK for working with the Labstep API
 Home-page: http://github.com/Labstep/labstepPy
 Author: Labstep

labstep-3.28.2/labstep/constants/version.py

@@ -0,0 +1 @@
+VERSION = "3.28.2"

labstep-3.28.2/labstep/service/htmlToPDF.py

@@ -0,0 +1,49 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+# Author: Labstep <dev@labstep.com>
+
+from labstep.service.request import requestService
+from labstep.constants import UNSPECIFIED
+import json
+
+
+def htmlToPDF(authenticatedUser, html=UNSPECIFIED,file_id=UNSPECIFIED,returnFile=False):
+    """
+    Converts HTML into the JSON format used in protocols
+    and experiment entries.
+
+    Parameters
+    ----------
+    authenticatedUser (:)
+        An authenticated Labstep :class:`~labstep.entities.user.model.User`
+        (see :func:`~labstep.authenticate`)
+    html (str)
+        HTML to be converted (as a string).
+    """
+    headers = {"Authorization": f"Bearer {authenticatedUser.token}"}
+
+    if html is UNSPECIFIED and file_id is UNSPECIFIED:
+        raise ValueError("html or file_id must be provided")
+
+    body = {"group_id": authenticatedUser.activeWorkspace}
+
+    if html is not UNSPECIFIED:
+        body["html"] = html
+
+    if file_id is not UNSPECIFIED:
+        body["file_id"] = file_id
+
+    url = "https://pdf-generator.labstep.com"
+    response = requestService.post(url, json=body, headers=headers)
+
+    fileID = json.loads(response.content)["file_id"]
+    file = authenticatedUser.getFile(fileID)
+
+    file.save()
+
+
+    if returnFile:
+        return file
+    else:
+        data = file.getData()
+        return data

{labstep-3.28.0 → labstep-3.28.2}/labstep/service/request.py

@@ -75,9 +75,9 @@ class RequestService:
                                 filterUnspecified(params)))
         return response
 
-    def post(self, url, headers, json=None, files=None, data=None):
+    def post(self, url, headers, json=None, files=None, data=None, params=None):
         response = http.post(
-            url, headers=headers, json=filterUnspecified(json), files=files, data=data
+            url, headers=headers, json=filterUnspecified(json), files=files, data=data, params=filterUnspecified(params)
         )
         return response
 

{labstep-3.28.0 → labstep-3.28.2}/labstep.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: labstep
-Version: 3.28.0
+Version: 3.28.2
 Summary: Python SDK for working with the Labstep API
 Home-page: http://github.com/Labstep/labstepPy
 Author: Labstep

labstep-3.28.0/labstep/constants/version.py

@@ -1 +0,0 @@
-VERSION = "3.28.0"

labstep-3.28.0/labstep/service/htmlToPDF.py

@@ -1,29 +0,0 @@
-#!/usr/bin/env python3
-# -*- coding: utf-8 -*-
-# Author: Labstep <dev@labstep.com>
-
-from labstep.service.request import requestService
-import base64
-
-
-def htmlToPDF(authenticatedUser, html):
-    """
-    Converts HTML into the JSON format used in protocols
-    and experiment entries.
-
-    Parameters
-    ----------
-    authenticatedUser (:)
-        An authenticated Labstep :class:`~labstep.entities.user.model.User`
-        (see :func:`~labstep.authenticate`)
-    html (str)
-        HTML to be converted (as a string).
-    """
-    headers = {"Authorization": f"Bearer {authenticatedUser.token}"}
-
-    body = {"html": html}
-
-    url = "https://pdf-generator.labstep.com"
-    response = requestService.post(url, json=body, headers=headers)
-
-    return base64.b64decode(response.content)