xlwings-utils 25.0.4__tar.gz → 25.0.5__tar.gz

{xlwings_utils-25.0.4 → xlwings_utils-25.0.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: xlwings_utils
-Version: 25.0.4
+Version: 25.0.5
 Summary: xlwings_utils
 Author-email: Ruud van der Ham <rt.van.der.ham@gmail.com>
 Project-URL: Homepage, https://github.com/salabim/xlwings_utils
@@ -19,7 +19,7 @@ This module provides some useful functions to be used in xlwings (lite).
 
 ## Installation
 
-Just add `xlwings-utils` and `ssl` to the *requirements.txt* tab. 
+Just add `xlwings-utils` and `ssl` (even if `dropbox` is not used) to the *requirements.txt* tab. 
 
 In the script, add
 
@@ -49,7 +49,7 @@ If an application runs under xlwings, `xwu.xlwings` will be True. False, if not.
 
 The xlwings lite system does not provide access to the local file system. With this module, files can be copied between Dropbox and the local pyodide file system, making it possible to indirectly use the local file system.
 
-It is only possible, as of now, to use full-access Dropbox apps.
+Currently, it is only possible to use full-access Dropbox apps.
 
 The easiest way to use the Dropbox functionality is to add the credentials to the environment variables. Add REFRESH_TOKEN, APP_KEY and APP_SECRET with their corresponding values to the environment variables. Instructions on how to get these variables can be found here.
 
@@ -86,7 +86,7 @@ xwu.write_dropbox('/downloads/file1.gif')
 ## Block support
 
 The module contains a useful 2-dimensional data structure: *block*.
-This can be useful to manipulate a range without accessing the range directly, which is expensive in terms of memory and execution time.
+This can be useful for manipulating a range without accessing it directly, which is expensive in terms of memory and execution time.
 The advantage over an ordinary list of lists is that a block is index one-based, in line with range and addressing is done with a row, column tuple.
 So, `my_block(lol)[row, col]` is roughly equivalent to `lol[row-1][col-1]`
 
@@ -136,7 +136,7 @@ for row in range(1, 10001):
 	this_block[row,2]= ...
 	if ...: # end condition
 	    break
-sheet.range(10,1).value = this_block.minimized().value
+sheet.range((10,1)).value = this_block.minimized().value
 ```
 
 In this case, only the really processed rows are copied to the sheet.
@@ -195,11 +195,11 @@ We then read the following rows (using hlookups) and access the required values.
 
 ### Filling a block from other sources
 
-The advantage of using a block instead of accessing these sources is	 that they are one-based, just like in Excel.
+The advantage of using a block instead of accessing these sources is that they are one-based, just like in Excel.
 
 It is possible to make a block from an xlrd worksheet with `block.from_xlrd_sheet`. 
 
-It is possible to make a block from a pandas dataframe with `block.from_dataframe`. Ensure that, if the dataframe is created by reading from an Excel sheet, headers=None is specified, e.g., `df = pd.read_excel(filename, header=None)`.
+It is possible to create a block from a Pandas DataFrame using `block.from_dataframe`. Ensure that, if the dataframe is created by reading from an Excel sheet, headers=None is specified, e.g., `df = pd.read_excel(filename, header=None)`.
 
 It is possible to make a block from an openpyxl worksheet with `block.from_openpyxl_sheet`. 
 
@@ -235,9 +235,9 @@ capture = xwu.Capture(include_print=True)
 
 the stdout output is captured and printed.
 
-Capturing van be enabled and disabled at any time with `capture.enbaled = True` and `capture.enabled = False`.
+Capturing can be enabled and disabled at any time with `capture.enabled = True` and `capture.enabled = False`.
 
-And including print likewise with `capture.include_print`.
+And include print, likewise, with `capture.include_print`.
 
 Alternatively, a context manager is provided:
 
@@ -250,7 +250,7 @@ with capture:
 ```
 Note that stopping the capture, leaves the captured output in place, so it can be extended later.
 
-In either case, the captured output can be then copied to a sheet, like
+In either case, the captured output can then be copied to a sheet, like
 
 ```
 sheet.range(4,5).value = capture.value

{xlwings_utils-25.0.4 → xlwings_utils-25.0.5}/README.md

@@ -6,7 +6,7 @@ This module provides some useful functions to be used in xlwings (lite).
 
 ## Installation
 
-Just add `xlwings-utils` and `ssl` to the *requirements.txt* tab. 
+Just add `xlwings-utils` and `ssl` (even if `dropbox` is not used) to the *requirements.txt* tab. 
 
 In the script, add
 
@@ -36,7 +36,7 @@ If an application runs under xlwings, `xwu.xlwings` will be True. False, if not.
 
 The xlwings lite system does not provide access to the local file system. With this module, files can be copied between Dropbox and the local pyodide file system, making it possible to indirectly use the local file system.
 
-It is only possible, as of now, to use full-access Dropbox apps.
+Currently, it is only possible to use full-access Dropbox apps.
 
 The easiest way to use the Dropbox functionality is to add the credentials to the environment variables. Add REFRESH_TOKEN, APP_KEY and APP_SECRET with their corresponding values to the environment variables. Instructions on how to get these variables can be found here.
 
@@ -73,7 +73,7 @@ xwu.write_dropbox('/downloads/file1.gif')
 ## Block support
 
 The module contains a useful 2-dimensional data structure: *block*.
-This can be useful to manipulate a range without accessing the range directly, which is expensive in terms of memory and execution time.
+This can be useful for manipulating a range without accessing it directly, which is expensive in terms of memory and execution time.
 The advantage over an ordinary list of lists is that a block is index one-based, in line with range and addressing is done with a row, column tuple.
 So, `my_block(lol)[row, col]` is roughly equivalent to `lol[row-1][col-1]`
 
@@ -123,7 +123,7 @@ for row in range(1, 10001):
 	this_block[row,2]= ...
 	if ...: # end condition
 	    break
-sheet.range(10,1).value = this_block.minimized().value
+sheet.range((10,1)).value = this_block.minimized().value
 ```
 
 In this case, only the really processed rows are copied to the sheet.
@@ -182,11 +182,11 @@ We then read the following rows (using hlookups) and access the required values.
 
 ### Filling a block from other sources
 
-The advantage of using a block instead of accessing these sources is	 that they are one-based, just like in Excel.
+The advantage of using a block instead of accessing these sources is that they are one-based, just like in Excel.
 
 It is possible to make a block from an xlrd worksheet with `block.from_xlrd_sheet`. 
 
-It is possible to make a block from a pandas dataframe with `block.from_dataframe`. Ensure that, if the dataframe is created by reading from an Excel sheet, headers=None is specified, e.g., `df = pd.read_excel(filename, header=None)`.
+It is possible to create a block from a Pandas DataFrame using `block.from_dataframe`. Ensure that, if the dataframe is created by reading from an Excel sheet, headers=None is specified, e.g., `df = pd.read_excel(filename, header=None)`.
 
 It is possible to make a block from an openpyxl worksheet with `block.from_openpyxl_sheet`. 
 
@@ -222,9 +222,9 @@ capture = xwu.Capture(include_print=True)
 
 the stdout output is captured and printed.
 
-Capturing van be enabled and disabled at any time with `capture.enbaled = True` and `capture.enabled = False`.
+Capturing can be enabled and disabled at any time with `capture.enabled = True` and `capture.enabled = False`.
 
-And including print likewise with `capture.include_print`.
+And include print, likewise, with `capture.include_print`.
 
 Alternatively, a context manager is provided:
 
@@ -237,7 +237,7 @@ with capture:
 ```
 Note that stopping the capture, leaves the captured output in place, so it can be extended later.
 
-In either case, the captured output can be then copied to a sheet, like
+In either case, the captured output can then be copied to a sheet, like
 
 ```
 sheet.range(4,5).value = capture.value

{xlwings_utils-25.0.4 → xlwings_utils-25.0.5}/pyproject.toml

@@ -10,7 +10,7 @@ authors = [
     { name = "Ruud van der Ham", email = "rt.van.der.ham@gmail.com" },
 ]
 description = "xlwings_utils"
-version = "25.0.4"
+version = "25.0.5"
 readme = "README.md"
 requires-python = ">=3.9"
 dependencies = [

{xlwings_utils-25.0.4 → xlwings_utils-25.0.5}/xlwings_utils/xlwings_utils.py

@@ -5,7 +5,7 @@
 #  /_/\_\|_|  \_/\_/  |_||_| |_| \__, ||___/ _____  \__,_| \__||_||_||___/
 #                                |___/      |_____|
 
-__version__ = "25.0.4"
+__version__ = "25.0.5"
 
 
 import dropbox
@@ -13,6 +13,7 @@ from pathlib import Path
 import os
 import sys
 import math
+import base64
 
 dbx = None
 Pythonista = sys.platform == "ios"
@@ -786,5 +787,69 @@ class Capture:
         self._include_print = value
 
 
+def trigger_VBA(book):
+    """
+    triggers the macro on sheet VBA in book
+
+    Parameters
+    ----------
+    book : xw.Book
+        book to use
+    """
+
+    book.sheets["VBA"]["A1"].value = "=NOW()"
+
+
+def init_transfer_files(book):
+    """
+    initializes the file info on sheet VBA in book
+
+    should be called prior to calling any transfer_file()
+
+    Parameters
+    ----------
+    book : xw.Book
+        book to use
+    """
+
+    global row1
+    book.sheets["VBA"].range((10, 1), (1000000, 1)).clear()
+    row1 = 10
+
+
+def transfer_file(book, file):
+    """
+    makes the local file to be encoded on sheet VBA in book
+    to be triggered later
+
+    init_transfer_files should be called prior to any transfer_file()
+
+    Parameters
+    ----------
+    book : xw.Book
+        book to use
+
+    file : string
+        name of file to be encoded
+    """
+
+    global row1
+    ws = book.sheets("VBA")
+    ws_block = block(number_of_rows=50000, number_of_columns=1)
+    n = 5000  # block size
+    row = 1
+    ws_block[row, 1] = f"<file={file}>"
+    row += 1
+    b64 = base64.b64encode(open(file, "rb").read()).decode("utf-8")
+    while b64:
+        b64_n = b64[:n]
+        ws_block[row, 1] = b64_n
+        row += 1
+        b64 = b64[n:]
+    ws_block[row, 1] = f"</file>"
+    ws.range((row1, 1)).value = ws_block.minimized().value
+    row1 += ws_block.highest_used_row_number
+
+
 if __name__ == "__main__":
     ...

{xlwings_utils-25.0.4 → xlwings_utils-25.0.5}/xlwings_utils.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: xlwings_utils
-Version: 25.0.4
+Version: 25.0.5
 Summary: xlwings_utils
 Author-email: Ruud van der Ham <rt.van.der.ham@gmail.com>
 Project-URL: Homepage, https://github.com/salabim/xlwings_utils
@@ -19,7 +19,7 @@ This module provides some useful functions to be used in xlwings (lite).
 
 ## Installation
 
-Just add `xlwings-utils` and `ssl` to the *requirements.txt* tab. 
+Just add `xlwings-utils` and `ssl` (even if `dropbox` is not used) to the *requirements.txt* tab. 
 
 In the script, add
 
@@ -49,7 +49,7 @@ If an application runs under xlwings, `xwu.xlwings` will be True. False, if not.
 
 The xlwings lite system does not provide access to the local file system. With this module, files can be copied between Dropbox and the local pyodide file system, making it possible to indirectly use the local file system.
 
-It is only possible, as of now, to use full-access Dropbox apps.
+Currently, it is only possible to use full-access Dropbox apps.
 
 The easiest way to use the Dropbox functionality is to add the credentials to the environment variables. Add REFRESH_TOKEN, APP_KEY and APP_SECRET with their corresponding values to the environment variables. Instructions on how to get these variables can be found here.
 
@@ -86,7 +86,7 @@ xwu.write_dropbox('/downloads/file1.gif')
 ## Block support
 
 The module contains a useful 2-dimensional data structure: *block*.
-This can be useful to manipulate a range without accessing the range directly, which is expensive in terms of memory and execution time.
+This can be useful for manipulating a range without accessing it directly, which is expensive in terms of memory and execution time.
 The advantage over an ordinary list of lists is that a block is index one-based, in line with range and addressing is done with a row, column tuple.
 So, `my_block(lol)[row, col]` is roughly equivalent to `lol[row-1][col-1]`
 
@@ -136,7 +136,7 @@ for row in range(1, 10001):
 	this_block[row,2]= ...
 	if ...: # end condition
 	    break
-sheet.range(10,1).value = this_block.minimized().value
+sheet.range((10,1)).value = this_block.minimized().value
 ```
 
 In this case, only the really processed rows are copied to the sheet.
@@ -195,11 +195,11 @@ We then read the following rows (using hlookups) and access the required values.
 
 ### Filling a block from other sources
 
-The advantage of using a block instead of accessing these sources is	 that they are one-based, just like in Excel.
+The advantage of using a block instead of accessing these sources is that they are one-based, just like in Excel.
 
 It is possible to make a block from an xlrd worksheet with `block.from_xlrd_sheet`. 
 
-It is possible to make a block from a pandas dataframe with `block.from_dataframe`. Ensure that, if the dataframe is created by reading from an Excel sheet, headers=None is specified, e.g., `df = pd.read_excel(filename, header=None)`.
+It is possible to create a block from a Pandas DataFrame using `block.from_dataframe`. Ensure that, if the dataframe is created by reading from an Excel sheet, headers=None is specified, e.g., `df = pd.read_excel(filename, header=None)`.
 
 It is possible to make a block from an openpyxl worksheet with `block.from_openpyxl_sheet`. 
 
@@ -235,9 +235,9 @@ capture = xwu.Capture(include_print=True)
 
 the stdout output is captured and printed.
 
-Capturing van be enabled and disabled at any time with `capture.enbaled = True` and `capture.enabled = False`.
+Capturing can be enabled and disabled at any time with `capture.enabled = True` and `capture.enabled = False`.
 
-And including print likewise with `capture.include_print`.
+And include print, likewise, with `capture.include_print`.
 
 Alternatively, a context manager is provided:
 
@@ -250,7 +250,7 @@ with capture:
 ```
 Note that stopping the capture, leaves the captured output in place, so it can be extended later.
 
-In either case, the captured output can be then copied to a sheet, like
+In either case, the captured output can then be copied to a sheet, like
 
 ```
 sheet.range(4,5).value = capture.value