ssb-pubmd 0.0.9__py3-none-any.whl → 0.0.10__py3-none-any.whl

ssb_pubmd/browser_context.py

@@ -7,15 +7,18 @@ from .notebook_syncer import Response
 
 
 class BrowserRequestContext:
-    """Creates a logged in browser context from which to send requests."""
+    """This class is used to create a logged in browser context from which to send requests."""
 
     def __init__(self) -> None:
-        """Initializes a browser context with a login url."""
+        """Initializes an empty browser context object."""
         self._storage_state_path: str = "browser_context.json"
         self._context: BrowserContext | None = None
 
     async def create_new(self, login_url: str) -> BrowserContext:
-        """Creates a browser context by opening a logging page and waiting for it to be closed by user."""
+        """Creates a browser context by opening a login page and waiting for it to be closed by user.
+
+        This function also saves the browser context to a file for later use.
+        """
         playwright = await async_playwright().start()
         browser = await playwright.chromium.launch(headless=False)
 
@@ -30,7 +33,7 @@ class BrowserRequestContext:
         return self._context
 
     async def recreate_from_file(self) -> BrowserContext:
-        """Restores a browser context from the storage state file."""
+        """Recreates a browser context object from a file."""
         playwright = await async_playwright().start()
         browser = await playwright.chromium.launch(headless=False)
 
@@ -46,7 +49,7 @@ class BrowserRequestContext:
         headers: dict[str, str] | None = None,
         data: dict[str, str] | None = None,
     ) -> Response:
-        """Sends a request tp the specified url, optionally with headers and data, within the browser context."""
+        """Sends a request to the specified url, optionally with headers and data, within the browser context."""
         if self._context is None:
             raise ValueError("Browser context has not been created.")
 

ssb_pubmd/notebook_syncer.py

@@ -20,7 +20,7 @@ class Response:
 class RequestContext(Protocol):
     """Interface for the context in which a request is sent.
 
-    Implementing classes may handle authentication, session management, etc.
+    Implementing classes may handle authentication, sessions, etc.
     """
 
     async def send_request(
@@ -65,7 +65,7 @@ class BasicRequestContext:
 
 
 class NotebookSyncer:
-    """Utility class that helps syncing a notebook to a CMS (Content Management System).
+    """This class syncs a notebook to a CMS (Content Management System).
 
     The CMS must have an endpoint that satisfies the following constraints:
 
@@ -127,7 +127,7 @@ class NotebookSyncer:
             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."""
+        """Fetches the content id from the data file if it exists, otherwise an empty string."""
         content_id = ""
 
         filename = self.data_path

{ssb_pubmd-0.0.9.dist-info → ssb_pubmd-0.0.10.dist-info}/METADATA

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

ssb_pubmd-0.0.10.dist-info/RECORD

@@ -0,0 +1,10 @@
+ssb_pubmd/__init__.py,sha256=bEVVJ-sm5MmH5bXnzzyek_nSAvutyB0WNpBy835lE2g,179
+ssb_pubmd/__main__.py,sha256=8D0yedPhnV_2L7nj0s0KUKxNQqPxoussMHGDNM-vyjg,209
+ssb_pubmd/browser_context.py,sha256=ihFYos4Vm-0Llgr5WlFRAITlE6CAY1D53baMF5rzxwI,2405
+ssb_pubmd/notebook_syncer.py,sha256=cyfB7jsXUVIaohVt38x8TKxlllkk1txy5jVab8vclSc,6511
+ssb_pubmd/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+ssb_pubmd-0.0.10.dist-info/LICENSE,sha256=tF5bnYv09fgH5ph9t1EpH1MGrVOGTQeswL4dzVeZ_ak,1073
+ssb_pubmd-0.0.10.dist-info/METADATA,sha256=Ylp5hVFos3KaDjGpbJBgngtmB6lsLugntRTaRvIDDAo,4407
+ssb_pubmd-0.0.10.dist-info/WHEEL,sha256=XbeZDeTWKc1w7CSIyre5aMDU_-PohRwTQceYnisIYYY,88
+ssb_pubmd-0.0.10.dist-info/entry_points.txt,sha256=o4oU99zbZNIBKGYWdgdEG6ev-62ZRWEJOe7EOjJaajk,53
+ssb_pubmd-0.0.10.dist-info/RECORD,,

ssb_pubmd-0.0.9.dist-info/RECORD

@@ -1,10 +0,0 @@
-ssb_pubmd/__init__.py,sha256=bEVVJ-sm5MmH5bXnzzyek_nSAvutyB0WNpBy835lE2g,179
-ssb_pubmd/__main__.py,sha256=8D0yedPhnV_2L7nj0s0KUKxNQqPxoussMHGDNM-vyjg,209
-ssb_pubmd/browser_context.py,sha256=V4KyL9Ell2xlW5LnDFQNa0p16TDCnOEXduYtH1UW4p0,2309
-ssb_pubmd/notebook_syncer.py,sha256=w0SXHaT5Ubxzs1CfGHdbe6kW1vqHz7HgY90ZZK1Py0M,6537
-ssb_pubmd/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-ssb_pubmd-0.0.9.dist-info/LICENSE,sha256=tF5bnYv09fgH5ph9t1EpH1MGrVOGTQeswL4dzVeZ_ak,1073
-ssb_pubmd-0.0.9.dist-info/METADATA,sha256=ZIJBSX_aNAPyBjkKvdncKxl8BAox_QvYQY7nOJftjPI,4406
-ssb_pubmd-0.0.9.dist-info/WHEEL,sha256=XbeZDeTWKc1w7CSIyre5aMDU_-PohRwTQceYnisIYYY,88
-ssb_pubmd-0.0.9.dist-info/entry_points.txt,sha256=o4oU99zbZNIBKGYWdgdEG6ev-62ZRWEJOe7EOjJaajk,53
-ssb_pubmd-0.0.9.dist-info/RECORD,,