xlwings-utils 0.0.0__py3-none-any.whl → 0.0.1__py3-none-any.whl

xlwings_utils/xlwings_utils.py

@@ -5,5 +5,228 @@
 #  /_/\_\|_|  \_/\_/  |_||_| |_| \__, ||___/ _____  \__,_| \__||_||_||___/
 #                                |___/      |_____|
 
-__version__ = "0.0.0"
+__version__ = "0.0.1"
 
+
+import dropbox
+from pathlib import Path
+import sys
+
+_captured_stdout = []
+dbx = None
+
+
+def dropbox_init(refresh_token, app_key, app_secret):
+    '''
+    dropbox initialize
+
+    This function has to be called prior to using any dropbox function
+
+    Parameters
+    ----------
+    refresh_token : str
+        oauth2 refreshntoken
+        
+    app_key : str
+        app key
+        
+    app_secret : str
+        app secret
+
+
+    Returns
+    -------
+    -
+    '''
+    global dbx
+    dbx = dropbox.Dropbox(oauth2_refresh_token=refresh_token, app_key=app_key, app_secret=app_secret)
+    
+def _check_dbx():
+    if dbx is None:
+        raise ValueError('not initialized. Please call dropbox_init()')
+
+
+def list_dropbox(path="", recursive=False):
+    '''
+    list_dropbox
+    
+    returns all dropbox files in path
+    
+    Parameters
+    ----------
+    path : str or Pathlib.Path
+        path from which to list all files (default: '')
+        
+        
+    recursive : bool
+        if True, recursively list files. if False (default) no recursion
+        
+    Returns
+    -------
+    files, relative to path : list
+    '''
+    _check_dbx()
+    out = []
+    result = dbx.files_list_folder(path, recursive=recursive)
+
+    for entry in result.entries:
+        if isinstance(entry, dropbox.files.FileMetadata):
+            out.append(entry.path_display)
+
+    while result.has_more:
+        result = dbx.files_list_folder_continue(result.cursor)
+        for entry in result.entries:
+            if isinstance(entry, dropbox.files.FileMetadata):
+                out.append(entry.path_display)
+
+    return out
+
+
+def read_dropbox(dropbox_path):
+    '''
+    read_dropbox
+    
+    read from dopbox at given path
+    
+    Parameters
+    ----------
+    path : str or Pathlib.Path
+        path to read from
+        
+    Returns
+    -------
+    contents of the dropbox file : bytes
+    '''
+
+    _check_dbx()
+    metadata, response = dbx.files_download(dropbox_path)
+    file_content = response.content
+    return file_content
+
+
+def write_dropbox(dropbox_path, contents):
+    _check_dbx()
+    dbx.files_upload(contents, dropbox_path, mode=dropbox.files.WriteMode.overwrite)
+
+
+def list_pyodide(path):
+    path = Path(path)
+    return list(path.iterdir())
+
+
+def write_pyodide(path, contents):
+    path = Path(path)
+    path.parent.mkdir(parents=True, exist_ok=True)
+    with open(path, "wb") as f:
+        f.write(contents)
+
+
+def read_pyodide(path):
+    path = Path(path)
+    with open(path, "rb") as f:
+        contents = f.read()
+
+
+def clear_captured_stdout():
+    """
+    empties the captured stdout
+    """
+    _captured_stdout.clear()
+
+
+def captured_stdout_as_str():
+    """
+    returns the captured stdout as a list of strings
+
+    Returns
+    -------
+    captured stdout : list
+        each line is an element of the list
+    """
+
+    return "".join(_captured_stdout)
+
+
+def captured_stdout_as_range():
+    """
+    returns the captured stdout as a list of strings
+
+    Returns
+    -------
+    captured stdout : list
+        each line is an element of the list
+    """
+
+    return [[line] for line in captured_stdout_as_str().splitlines()]
+
+
+class capture_stdout:
+    """
+    specifies how to capture stdout
+
+    Parameters
+    ----------
+    include_print : bool
+        if True (default), the output is also printed out as normal
+
+        if False, no output is printed
+
+    Note
+    ----
+    This function is normally used as a context manager, like ::
+
+        with capture_stdout():
+            ...
+    """
+
+    def __init__(self, include_print: bool = True):
+        self.stdout = sys.stdout
+        self.include_print = include_print
+
+    def __enter__(self):
+        sys.stdout = self
+
+    def __exit__(self, exc_type, exc_value, tb):
+        sys.stdout = self.stdout
+
+    def write(self, data):
+        _captured_stdout.append(data)
+        if self.include_print:
+            self.stdout.write(data)
+
+    def flush(self):
+        if self.include_print:
+            self.stdout.flush()
+        _captured_stdout.append("\n")
+
+
+if __name__ == "__main__":
+    ...
+
+
+# @xw.script
+# def test_stdout(book: xw.Book):
+#     with capture_stdout():
+#         for i in range(10):
+#             print(10 * f'{i}')
+#     book.sheets.active.range("A1").value=captured_stdout_as_range()
+
+
+# @xw.script
+# def test(book: xw.Book):
+#     dropbox_init(
+#         refresh_token=REFRESH_TOKEN,
+#         app_key=APP_KEY,
+#         app_secret=APP_SECRET,
+#     )
+
+#     files =list_dropbox("/Downloads",recursive=True)
+#     peek(files)
+#     write_pyodide("Test/x.x", b"abc")
+#     files = list_pyodide("Test")
+
+#     # files=list_dropbox_files("/Downloads")
+#     # peek(files)
+#     contents = read_dropbox("/Downloads/dropbox setup.py")
+#     write_dropbox("/Downloads/dropbox setup1.py", contents)
+#     peek("done")

xlwings_utils-0.0.1.dist-info/METADATA

@@ -0,0 +1,43 @@
+Metadata-Version: 2.4
+Name: xlwings_utils
+Version: 0.0.1
+Summary: xlwings_utils
+Author-email: Ruud van der Ham <rt.van.der.ham@gmail.com>
+Project-URL: Homepage, https://github.com/salabim/xlwings_utils
+Project-URL: Repository, https://github.com/salabim/xlwings_utils
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Programming Language :: Python :: 3 :: Only
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+Requires-Dist: dropbox
+
+# xlwings_utils
+
+## Introduction
+
+This module provides some useful functiona to be used in xlwings lite.
+The xlwings lite system does not provide access to the local file system. With this
+module, files can be copied between dropbox and the pyodide file systen. And
+therefore, it is possible to indirectly use the local file system.
+
+On top of that, this module makes it possible to capture stdout writes, which
+can then be copied to a worksheet in a later stage.
+
+## Installation
+
+Just add xlwings-utils to the requirement tab.
+
+## Dropbox support
+
+xlwings_lite only works with full access dropbox apps.
+
+In order to use dropbox, is is necessary to initialize the module with credentials.
+
+## Capture stdout support
+
+ Badges
+
+![PyPI](https://img.shields.io/pypi/v/xlwings-utils) ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/xlwings-utils) ![PyPI - Implementation](https://img.shields.io/pypi/implementation/xlwings-utils)
+![PyPI - License](https://img.shields.io/pypi/l/xlwings-utils) ![ruff](https://img.shields.io/badge/style-ruff-41B5BE?style=flat) 
+![GitHub last commit](https://img.shields.io/github/last-commit/salabim/peek)
+

xlwings_utils-0.0.1.dist-info/RECORD

@@ -0,0 +1,6 @@
+xlwings_utils/__init__.py,sha256=FdaRztevSu5akGL7KBUBRzqwLMRTdvVUuS2Kfp2f1Uc,68
+xlwings_utils/xlwings_utils.py,sha256=vc_w_NdyfQLX4vrq0PARMtxYoFYAn39UuUzi8FqlGCc,5234
+xlwings_utils-0.0.1.dist-info/METADATA,sha256=3PoU8ESYGmgGQPCLj3ilC3TeeMxi8azkccGq_YEH3yU,1662
+xlwings_utils-0.0.1.dist-info/WHEEL,sha256=SmOxYU7pzNKBqASvQJ7DjX3XGUF92lrGhMb3R6_iiqI,91
+xlwings_utils-0.0.1.dist-info/top_level.txt,sha256=kf5SEv0gZiRObPhUoYcc1O_iX_wwTOPeUIYvzyYeAM4,14
+xlwings_utils-0.0.1.dist-info/RECORD,,

{xlwings_utils-0.0.0.dist-info → xlwings_utils-0.0.1.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (78.1.1)
+Generator: setuptools (79.0.1)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

xlwings_utils-0.0.0.dist-info/METADATA

@@ -1,23 +0,0 @@
-Metadata-Version: 2.4
-Name: xlwings_utils
-Version: 0.0.0
-Summary: xlwings_utils
-Author-email: Ruud van der Ham <rt.van.der.ham@gmail.com>
-Project-URL: Homepage, https://github.com/salabim/xlwings_utils
-Project-URL: Repository, https://github.com/salabim/xlwings_utils
-Classifier: Development Status :: 5 - Production/Stable
-Classifier: Programming Language :: Python :: 3 :: Only
-Requires-Python: >=3.9
-Description-Content-Type: text/markdown
-Requires-Dist: dropbox
-
-# xlwings_utils
-
-## Introduction
-
- Badges
-
-![PyPI](https://img.shields.io/pypi/v/xlwings_utils) ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/xlwings_utils) ![PyPI - Implementation](https://img.shields.io/pypi/implementation/xlwings_utils)
-![PyPI - License](https://img.shields.io/pypi/l/xlwings_utils) ![ruff](https://img.shields.io/badge/style-ruff-41B5BE?style=flat) 
-![GitHub last commit](https://img.shields.io/github/last-commit/salabim/peek)
-

xlwings_utils-0.0.0.dist-info/RECORD

@@ -1,6 +0,0 @@
-xlwings_utils/__init__.py,sha256=FdaRztevSu5akGL7KBUBRzqwLMRTdvVUuS2Kfp2f1Uc,68
-xlwings_utils/xlwings_utils.py,sha256=KV-Hrm1YGQz-YJeirfna0ojfqj486sPZa_aXWGuhz4Q,444
-xlwings_utils-0.0.0.dist-info/METADATA,sha256=2M20uewewm6G-pbiKXJEAhdbt-P5EUYNM0IxAtDKSrs,958
-xlwings_utils-0.0.0.dist-info/WHEEL,sha256=lTU6B6eIfYoiQJTZNc-fyaR6BpL6ehTzU3xGYxn2n8k,91
-xlwings_utils-0.0.0.dist-info/top_level.txt,sha256=kf5SEv0gZiRObPhUoYcc1O_iX_wwTOPeUIYvzyYeAM4,14
-xlwings_utils-0.0.0.dist-info/RECORD,,