xlwings-utils 25.0.6__tar.gz → 25.0.6.post0__tar.gz

{xlwings_utils-25.0.6 → xlwings_utils-25.0.6.post0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: xlwings_utils
-Version: 25.0.6
+Version: 25.0.6.post0
 Summary: xlwings_utils
 Author-email: Ruud van der Ham <rt.van.der.ham@gmail.com>
 Project-URL: Homepage, https://github.com/salabim/xlwings_utils
@@ -62,7 +62,7 @@ python -c "exec(__import__('requests').get('https://salabim.org/dropbox setup.py
 Then, it is possible to list all files in a specified folder using the list_dropbox function.
 It is also possible to get the folders and to access all underlying folders.
 
-The `read_dropbox` function can be used to read the contents (bytes) of a Dropbox file. As reading from Dropbox under pyodide is very unreliable, xlwings_utils automatically retries several times (by default 100 times). The actual number of retries can be found with `read_dropbox.retries`.
+The `read_dropbox` function can be used to read the contents (bytes) of a Dropbox file. As reading from Dropbox under pyodide is rather unreliable, xlwings_utils automatically retries several times (by default 100 times). The actual number of retries can be found with `read_dropbox.retries`.
 
 The function `write_dropbox` can be used to write contents (bytes) to a Dropbox file.
 
@@ -269,11 +269,11 @@ Currently, *xlwings Lite* does not provide access to the local file system. Ther
 Files can be encoded into a block, like:
 
 ```
-    bl = xwu.block.encode_files("film1.mp4", "settings.txt")
-    book.sheets["VBA"].range((10,2)).value=bl.value
+    bl = xwu.block.encode_file("film1.mp4")
+    book.sheets["VBA"].range((10,1)).value=bl.value
 ```
 
-With this code, column B will be filled with encoded copies of the files *film1.mp4* and *settings.txt* . This can then be used with a suitable VBA macro to decode to the real file system. A VBA macro can be triggered with `xwu.trigger_macro()`. This requires an Excel worksheet where cell A1 is reserved for communication with xlwings lite. This worksheet needs to contain a macro, like
+With this code, column A will be filled with an encoded copy of the files *film1.mp4* . This can then be used with a suitable VBA macro to decode to the real file system. A VBA macro can be triggered with `xwu.trigger_macro()`. This requires an Excel worksheet where cell A1 is reserved for communication with xlwings lite. This worksheet needs to contain a macro, like
 
 ```
 Private Sub Worksheet_Calculate()
@@ -284,66 +284,34 @@ Private Sub Worksheet_Calculate()
 End Sub
 ```
 
-, where `MacroToExecute` should contain the user code, most likely code to decode files encoded with something like
+, where `MacroToExecute` should contain the user code, most likely code to decode file(s) encoded.
+
+The repo contains a VBA module called xlwings_utils.bas with code to decode encoded files.
+Just add the .bas file to a worksheet and call like
 
 ```
-bl.decode_to_files()
+Sub MacroToExecute()
+    DecodeFile(Me, 10, 1)
 ```
+    
+In this example, the file *film1.mp4* will be downloaded into the current directory.
 
-The VBA code below can be used to decode encoded file(s ) on a worksheet.
+The module xlwings_utils also contains code to encode a local file to a sheet:
 
 ```
-Sub DecodeFiles()
-    
-    Dim vArr() As Byte
-    Dim S As String
-    Dim Column As Integer
-    Dim Row As Integer
-    Dim ws As Worksheet
-    Dim Count As Integer
-    Dim FileNames As String
-    
-    Column = 2
-    Row = 1
-    
-    ThisDir = ThisWorkbook.Path
-    Set ws = Me
-    Count = 0
-    While Row < 30000
-        Line = ws.Cells(Row, Column)
-        If InStr(Line, "<file=") = 1 And Right(Line, 1) = ">" Then
-            If Count <> 0 Then
-                FileNames = FileNames & ", "
-            End If
-            Count = Count + 1
-            FileNameOnly = Mid(Line, 7, Len(Line) - 7)
-            Filename = ThisDir & "/" & FileNameOnly
-            FileNames = FileNames & FileNameOnly
-            
-            Row = Row + 1
-            S = ""
-            While ws.Cells(Row, Column) <> "</file>"
-                S = S & ws.Cells(Row, Column)
-                Row = Row + 1
-            Wend
-                
-            vArr = Base64ToArray(S)
-        
-            Open Filename For Binary Access Write As #1
-            WritePos = 1
-            Put #1, WritePos, vArr
-            Close #1
-        End If
-        
-        Row = Row + 1
-    
-    Wend
-    
-    If Count = 0 Then
-        MsgBox "No files to decode"
-    Else
-        MsgBox "Successfully decoded and written " & Str(Count) & " file(s): " & FileNames
-    End If
+Sub MacroToExecute()
+    EncodeFile(Me, "data.json", 10, 1)
+```
+
+This will place an encoded version of *data.json* on the sheet.
+
+Then, the file can be copied to the pyodide file system with
+
+```
+bl = block(xw.range((10,1),(50000,1)).decode_to_files())
+```
+```
+
 ```
 
 ## Contact info

{xlwings_utils-25.0.6 → xlwings_utils-25.0.6.post0}/README.md

@@ -49,7 +49,7 @@ python -c "exec(__import__('requests').get('https://salabim.org/dropbox setup.py
 Then, it is possible to list all files in a specified folder using the list_dropbox function.
 It is also possible to get the folders and to access all underlying folders.
 
-The `read_dropbox` function can be used to read the contents (bytes) of a Dropbox file. As reading from Dropbox under pyodide is very unreliable, xlwings_utils automatically retries several times (by default 100 times). The actual number of retries can be found with `read_dropbox.retries`.
+The `read_dropbox` function can be used to read the contents (bytes) of a Dropbox file. As reading from Dropbox under pyodide is rather unreliable, xlwings_utils automatically retries several times (by default 100 times). The actual number of retries can be found with `read_dropbox.retries`.
 
 The function `write_dropbox` can be used to write contents (bytes) to a Dropbox file.
 
@@ -256,11 +256,11 @@ Currently, *xlwings Lite* does not provide access to the local file system. Ther
 Files can be encoded into a block, like:
 
 ```
-    bl = xwu.block.encode_files("film1.mp4", "settings.txt")
-    book.sheets["VBA"].range((10,2)).value=bl.value
+    bl = xwu.block.encode_file("film1.mp4")
+    book.sheets["VBA"].range((10,1)).value=bl.value
 ```
 
-With this code, column B will be filled with encoded copies of the files *film1.mp4* and *settings.txt* . This can then be used with a suitable VBA macro to decode to the real file system. A VBA macro can be triggered with `xwu.trigger_macro()`. This requires an Excel worksheet where cell A1 is reserved for communication with xlwings lite. This worksheet needs to contain a macro, like
+With this code, column A will be filled with an encoded copy of the files *film1.mp4* . This can then be used with a suitable VBA macro to decode to the real file system. A VBA macro can be triggered with `xwu.trigger_macro()`. This requires an Excel worksheet where cell A1 is reserved for communication with xlwings lite. This worksheet needs to contain a macro, like
 
 ```
 Private Sub Worksheet_Calculate()
@@ -271,66 +271,34 @@ Private Sub Worksheet_Calculate()
 End Sub
 ```
 
-, where `MacroToExecute` should contain the user code, most likely code to decode files encoded with something like
+, where `MacroToExecute` should contain the user code, most likely code to decode file(s) encoded.
+
+The repo contains a VBA module called xlwings_utils.bas with code to decode encoded files.
+Just add the .bas file to a worksheet and call like
 
 ```
-bl.decode_to_files()
+Sub MacroToExecute()
+    DecodeFile(Me, 10, 1)
 ```
+    
+In this example, the file *film1.mp4* will be downloaded into the current directory.
 
-The VBA code below can be used to decode encoded file(s ) on a worksheet.
+The module xlwings_utils also contains code to encode a local file to a sheet:
 
 ```
-Sub DecodeFiles()
-    
-    Dim vArr() As Byte
-    Dim S As String
-    Dim Column As Integer
-    Dim Row As Integer
-    Dim ws As Worksheet
-    Dim Count As Integer
-    Dim FileNames As String
-    
-    Column = 2
-    Row = 1
-    
-    ThisDir = ThisWorkbook.Path
-    Set ws = Me
-    Count = 0
-    While Row < 30000
-        Line = ws.Cells(Row, Column)
-        If InStr(Line, "<file=") = 1 And Right(Line, 1) = ">" Then
-            If Count <> 0 Then
-                FileNames = FileNames & ", "
-            End If
-            Count = Count + 1
-            FileNameOnly = Mid(Line, 7, Len(Line) - 7)
-            Filename = ThisDir & "/" & FileNameOnly
-            FileNames = FileNames & FileNameOnly
-            
-            Row = Row + 1
-            S = ""
-            While ws.Cells(Row, Column) <> "</file>"
-                S = S & ws.Cells(Row, Column)
-                Row = Row + 1
-            Wend
-                
-            vArr = Base64ToArray(S)
-        
-            Open Filename For Binary Access Write As #1
-            WritePos = 1
-            Put #1, WritePos, vArr
-            Close #1
-        End If
-        
-        Row = Row + 1
-    
-    Wend
-    
-    If Count = 0 Then
-        MsgBox "No files to decode"
-    Else
-        MsgBox "Successfully decoded and written " & Str(Count) & " file(s): " & FileNames
-    End If
+Sub MacroToExecute()
+    EncodeFile(Me, "data.json", 10, 1)
+```
+
+This will place an encoded version of *data.json* on the sheet.
+
+Then, the file can be copied to the pyodide file system with
+
+```
+bl = block(xw.range((10,1),(50000,1)).decode_to_files())
+```
+```
+
 ```
 
 ## Contact info

{xlwings_utils-25.0.6 → xlwings_utils-25.0.6.post0}/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.6"
+version = "25.0.6.post0"
 readme = "README.md"
 requires-python = ">=3.9"
 dependencies = [

{xlwings_utils-25.0.6 → xlwings_utils-25.0.6.post0}/xlwings_utils/xlwings_utils.py

@@ -179,24 +179,24 @@ def read_dropbox(dropbox_path, max_retries=100):
     it is not necessary to call dropbox_init() prior to any dropbox function.
 
     As reading from dropbox is very unreliable under pyodide, reading will have to be retried (by default maximum 100 times).
-    The number of retries can be found with read_dropbox.retries
+    The number of retries can be found with read_dropbox.retries.
     """
 
     _login_dbx()
-    for read_dropbox.retries in range(max_retries+1):
+    for read_dropbox.retries in range(max_retries + 1):
         metadata, response = dbx.files_download(dropbox_path)
         file_content = response.content
         if len(file_content) == metadata.size:
             return file_content
     raise OSError(f"after {max_retries} still no valid response")
 
+
 def write_dropbox(dropbox_path, contents):
-    _login_dbx()
     """
     write_dropbox
-    
+
     write from dopbox at given path
-    
+
     Parameters
     ----------
     dropbox_path : str or Pathlib.Path
@@ -204,12 +204,13 @@ def write_dropbox(dropbox_path, contents):
 
     contents : bytes
         contents to be written
-        
+
     Note
     ----
     If REFRESH_TOKEN, APP_KEY and APP_SECRET environment variables are specified,
     it is not necessary to call dropbox_init() prior to any dropbox function.
     """
+    _login_dbx()
     dbx.files_upload(contents, dropbox_path, mode=dropbox.files.WriteMode.overwrite)
 
 
@@ -433,6 +434,19 @@ class block:
         if column > self.number_of_columns:
             raise ValueError(f"{name}={column} > number_of_columns={self.number_of_columns}")
 
+    def transpose(self):
+        """
+        transpose block
+
+        Returns
+        -------
+        transposed block : block
+        """
+        bl = block(number_of_rows=self.number_of_columns, number_of_columns=self.number_of_rows)
+        for (row, column), value in self.dict.items():
+            bl[column, row] = value
+        return bl
+
     def vlookup(self, s, *, row_from=1, row_to=missing, column1=1, column2=missing, default=missing):
         """
         searches in column1 for row between row_from and row_to for s and returns the value found at (that row, column2)
@@ -685,57 +699,57 @@ class block:
 
     def decode_to_files(self):
         """
-        decode the block with encoded file(s) to individual local files
+        decode the block with encoded file(s) to individual pyoidide files
         """
+        count = 0
         for column in self.number_of_columns:
             row = 1
+            bl = self.mimimized()
             while row <= self.number_of_rows:
                 if self[row, column] and self[row, column].startswith("<file=") and self[row, column].endswith(">"):
                     filename = self[row, column][6:-1]
                     collect = []
                     row += 1
-                    while self[row, column] != "</file>":
-                        print(f"{self[row,column]=}")
-
-                        if self[row, column]:
-                            collect.append(self[row, column])
+                    while bl[row, column] != "</file>":
+                        if bl[row, column]:
+                            collect.append(bl[row, column])
                         row += 1
                     decoded = base64.b64decode("".join(collect))
                     open(filename, "wb").write(decoded)
+                    count += 1
                 row += 1
+        return count
 
     @classmethod
-    def encode_files(cls, *files):
+    def encode_file(cls, file):
         """
-        make a block with the given files encoded
+        make a block with the given pyodide file encoded
 
         Parameters
         ----------
-        files : file names (str)
-            files to be encoded
+        file : file name (str)
+            file to be encoded
 
         Returns
         -------
-        block with encoded files : block
-            not minimized!
+        block with encoded file : block (minimized)
         """
 
-        bl = cls(number_of_rows=50000, number_of_columns=1)
+        bl = cls(number_of_rows=100000, number_of_columns=1)
 
         n = 5000  # block size
         row = 1
-        for file in files:
-            bl[row, 1] = f"<file={file}>"
+        bl[row, 1] = f"<file={file}>"
+        row += 1
+        b64 = base64.b64encode(open(file, "rb").read()).decode("utf-8")
+        while b64:
+            b64_n = b64[:n]
+            bl[row, 1] = b64_n
             row += 1
-            b64 = base64.b64encode(open(file, "rb").read()).decode("utf-8")
-            while b64:
-                b64_n = b64[:n]
-                bl[row, 1] = b64_n
-                row += 1
-                b64 = b64[n:]
-            bl[row, 1] = f"</file>"
-            row += 1
-        return bl
+            b64 = b64[n:]
+        bl[row, 1] = f"</file>"
+        row += 1
+        return bl.minimized()
 
 
 class Capture:
@@ -844,6 +858,7 @@ class Capture:
     def include_print(self, value):
         self._include_print = value
 
+
 def trigger_macro(sheet):
     """
     triggers the macro on sheet

{xlwings_utils-25.0.6 → xlwings_utils-25.0.6.post0}/xlwings_utils.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: xlwings_utils
-Version: 25.0.6
+Version: 25.0.6.post0
 Summary: xlwings_utils
 Author-email: Ruud van der Ham <rt.van.der.ham@gmail.com>
 Project-URL: Homepage, https://github.com/salabim/xlwings_utils
@@ -62,7 +62,7 @@ python -c "exec(__import__('requests').get('https://salabim.org/dropbox setup.py
 Then, it is possible to list all files in a specified folder using the list_dropbox function.
 It is also possible to get the folders and to access all underlying folders.
 
-The `read_dropbox` function can be used to read the contents (bytes) of a Dropbox file. As reading from Dropbox under pyodide is very unreliable, xlwings_utils automatically retries several times (by default 100 times). The actual number of retries can be found with `read_dropbox.retries`.
+The `read_dropbox` function can be used to read the contents (bytes) of a Dropbox file. As reading from Dropbox under pyodide is rather unreliable, xlwings_utils automatically retries several times (by default 100 times). The actual number of retries can be found with `read_dropbox.retries`.
 
 The function `write_dropbox` can be used to write contents (bytes) to a Dropbox file.
 
@@ -269,11 +269,11 @@ Currently, *xlwings Lite* does not provide access to the local file system. Ther
 Files can be encoded into a block, like:
 
 ```
-    bl = xwu.block.encode_files("film1.mp4", "settings.txt")
-    book.sheets["VBA"].range((10,2)).value=bl.value
+    bl = xwu.block.encode_file("film1.mp4")
+    book.sheets["VBA"].range((10,1)).value=bl.value
 ```
 
-With this code, column B will be filled with encoded copies of the files *film1.mp4* and *settings.txt* . This can then be used with a suitable VBA macro to decode to the real file system. A VBA macro can be triggered with `xwu.trigger_macro()`. This requires an Excel worksheet where cell A1 is reserved for communication with xlwings lite. This worksheet needs to contain a macro, like
+With this code, column A will be filled with an encoded copy of the files *film1.mp4* . This can then be used with a suitable VBA macro to decode to the real file system. A VBA macro can be triggered with `xwu.trigger_macro()`. This requires an Excel worksheet where cell A1 is reserved for communication with xlwings lite. This worksheet needs to contain a macro, like
 
 ```
 Private Sub Worksheet_Calculate()
@@ -284,66 +284,34 @@ Private Sub Worksheet_Calculate()
 End Sub
 ```
 
-, where `MacroToExecute` should contain the user code, most likely code to decode files encoded with something like
+, where `MacroToExecute` should contain the user code, most likely code to decode file(s) encoded.
+
+The repo contains a VBA module called xlwings_utils.bas with code to decode encoded files.
+Just add the .bas file to a worksheet and call like
 
 ```
-bl.decode_to_files()
+Sub MacroToExecute()
+    DecodeFile(Me, 10, 1)
 ```
+    
+In this example, the file *film1.mp4* will be downloaded into the current directory.
 
-The VBA code below can be used to decode encoded file(s ) on a worksheet.
+The module xlwings_utils also contains code to encode a local file to a sheet:
 
 ```
-Sub DecodeFiles()
-    
-    Dim vArr() As Byte
-    Dim S As String
-    Dim Column As Integer
-    Dim Row As Integer
-    Dim ws As Worksheet
-    Dim Count As Integer
-    Dim FileNames As String
-    
-    Column = 2
-    Row = 1
-    
-    ThisDir = ThisWorkbook.Path
-    Set ws = Me
-    Count = 0
-    While Row < 30000
-        Line = ws.Cells(Row, Column)
-        If InStr(Line, "<file=") = 1 And Right(Line, 1) = ">" Then
-            If Count <> 0 Then
-                FileNames = FileNames & ", "
-            End If
-            Count = Count + 1
-            FileNameOnly = Mid(Line, 7, Len(Line) - 7)
-            Filename = ThisDir & "/" & FileNameOnly
-            FileNames = FileNames & FileNameOnly
-            
-            Row = Row + 1
-            S = ""
-            While ws.Cells(Row, Column) <> "</file>"
-                S = S & ws.Cells(Row, Column)
-                Row = Row + 1
-            Wend
-                
-            vArr = Base64ToArray(S)
-        
-            Open Filename For Binary Access Write As #1
-            WritePos = 1
-            Put #1, WritePos, vArr
-            Close #1
-        End If
-        
-        Row = Row + 1
-    
-    Wend
-    
-    If Count = 0 Then
-        MsgBox "No files to decode"
-    Else
-        MsgBox "Successfully decoded and written " & Str(Count) & " file(s): " & FileNames
-    End If
+Sub MacroToExecute()
+    EncodeFile(Me, "data.json", 10, 1)
+```
+
+This will place an encoded version of *data.json* on the sheet.
+
+Then, the file can be copied to the pyodide file system with
+
+```
+bl = block(xw.range((10,1),(50000,1)).decode_to_files())
+```
+```
+
 ```
 
 ## Contact info