zipmanager 0.1.0__tar.gz

zipmanager-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 SimplePythonCoder
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

zipmanager-0.1.0/MANIFEST.in

@@ -0,0 +1,4 @@
+graft zipmanager
+include pyproject.toml
+include setup.py
+global-exclude *.py[cod]

zipmanager-0.1.0/PKG-INFO

@@ -0,0 +1,74 @@
+Metadata-Version: 2.1
+Name: zipmanager
+Version: 0.1.0
+Summary: Allows you to manage zip folders as data
+Home-page: https://github.com/SimplePythonCoder/zipmanager
+Author: SimplePythonCoder
+Author-email: 
+License: MIT
+Project-URL: Source, https://github.com/SimplePythonCoder/zipmanager
+Project-URL: Issues, https://github.com/SimplePythonCoder/zipmanager/issues
+Keywords: zip
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Topic :: Utilities
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+
+# zipmanager
+## What does this package do ?
+It allows you to create and handle zip folders as data without needing to save them.
+
+## Usage
+```python
+from zipmanager import ZipFolder
+
+file_data = b'some_data'
+
+zip_folder = ZipFolder({'file_name.file_extension': file_data})
+# file extension not required
+# ZipFile will hold all the files given in the dictionary
+
+file_data = zip_folder['file_name.file_extension']
+# will return the file data
+```
+
+## Main functions
+```python
+from zipmanager import ZipFolder
+file_data = b'some_data'
+zip_folder = ZipFolder({'file_name.file_extension': file_data})
+
+# list of functions:
+zip_folder.add_files({'new_file': 'new_data'}) # add files to zip. read more at docstring.
+zip_folder.delete_file('new_file') # removes file from zip
+
+zip_folder.get('file_name') # returns None if file was not found
+# or
+zip_folder['file_name']
+
+zip_folder.save() # saves zip in given location (empty is './temp.zip')
+```
+
+## File extension features
+json and text files data is automatically returned as a dict or str respectively:
+```python
+from zipmanager import ZipFolder
+
+file_data = b'{"key": "value"}'
+
+zip_folder = ZipFolder({'file_name.json': file_data})
+# .json extension is required to return a dict
+
+data = zip_folder['file_name.json']
+# will return a dict type
+
+# same for .txt
+file_data = {'key': 'value'}
+zip_folder = ZipFolder({'file_name.txt': file_data})
+data = zip_folder['file_name.txt']
+# will return a string
+```

zipmanager-0.1.0/README.md

@@ -0,0 +1,54 @@
+# zipmanager
+## What does this package do ?
+It allows you to create and handle zip folders as data without needing to save them.
+
+## Usage
+```python
+from zipmanager import ZipFolder
+
+file_data = b'some_data'
+
+zip_folder = ZipFolder({'file_name.file_extension': file_data})
+# file extension not required
+# ZipFile will hold all the files given in the dictionary
+
+file_data = zip_folder['file_name.file_extension']
+# will return the file data
+```
+
+## Main functions
+```python
+from zipmanager import ZipFolder
+file_data = b'some_data'
+zip_folder = ZipFolder({'file_name.file_extension': file_data})
+
+# list of functions:
+zip_folder.add_files({'new_file': 'new_data'}) # add files to zip. read more at docstring.
+zip_folder.delete_file('new_file') # removes file from zip
+
+zip_folder.get('file_name') # returns None if file was not found
+# or
+zip_folder['file_name']
+
+zip_folder.save() # saves zip in given location (empty is './temp.zip')
+```
+
+## File extension features
+json and text files data is automatically returned as a dict or str respectively:
+```python
+from zipmanager import ZipFolder
+
+file_data = b'{"key": "value"}'
+
+zip_folder = ZipFolder({'file_name.json': file_data})
+# .json extension is required to return a dict
+
+data = zip_folder['file_name.json']
+# will return a dict type
+
+# same for .txt
+file_data = {'key': 'value'}
+zip_folder = ZipFolder({'file_name.txt': file_data})
+data = zip_folder['file_name.txt']
+# will return a string
+```

zipmanager-0.1.0/pyproject.toml

@@ -0,0 +1,6 @@
+[build-system]
+requires = [
+    "setuptools>=69.2.0",
+    "wheel",
+]
+build-backend = "setuptools.build_meta"

zipmanager-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

zipmanager-0.1.0/setup.py

@@ -0,0 +1,32 @@
+import pathlib
+
+from setuptools import setup, find_packages
+
+# Setting up
+setup(
+    name="zipmanager",
+    version='0.1.0',
+    license="MIT",
+    author="SimplePythonCoder",
+    author_email="",
+    url='https://github.com/SimplePythonCoder/zipmanager',
+    description='Allows you to manage zip folders as data',
+    long_description=pathlib.Path('README.md').read_text(),
+    long_description_content_type="text/markdown",
+    packages=find_packages(),
+    include_package_data=True,
+    install_requires=[],
+    keywords=['zip'],
+    python_requires='>=3.11',
+    classifiers=[
+        'Development Status :: 3 - Alpha',
+        'Intended Audience :: Developers',
+        'Programming Language :: Python :: 3.11',
+        'Operating System :: Microsoft :: Windows',
+        'Topic :: Utilities',
+    ],
+    project_urls={
+        'Source': 'https://github.com/SimplePythonCoder/zipmanager',
+        'Issues': 'https://github.com/SimplePythonCoder/zipmanager/issues'
+    }
+)

zipmanager-0.1.0/zipmanager/Exceptions.py

@@ -0,0 +1,19 @@
+
+class NonBytesInput(Exception):
+    def __init__(self, file_name):
+        super().__init__(f'File {file_name} data must be bytes')
+
+
+class FileNameConflict(Exception):
+    def __init__(self, file_name):
+        super().__init__(f'File {file_name} already exists in the zip folder')
+
+
+class FileNotFound(Exception):
+    def __init__(self, file_name):
+        super().__init__(f'File {file_name} does no exist in the zip folder')
+
+
+class ExternalClassOperation(Exception):
+    def __init__(self, type_name):
+        super().__init__(f'type {type_name.__name__} cannot interact with the ZipFile class')

zipmanager-0.1.0/zipmanager/File.py

@@ -0,0 +1,32 @@
+import sys
+import json
+
+from .Exceptions import NonBytesInput
+
+
+class File:
+
+    @staticmethod
+    def __raise(exception):
+        raise exception
+
+    @classmethod
+    def pack(cls, name, data):
+        match name.split('.')[-1]:
+            case 'json':
+                return json.dumps(json.loads(data)) if type(data) is bytes else json.dumps(data)
+            case 'txt':
+                return data.decode() if type(data) is bytes else data if type(
+                    data) is str else cls.__raise(NonBytesInput(name))
+            case _:
+                return data if type(data) is bytes else cls.__raise(NonBytesInput(name))
+
+    @staticmethod
+    def unpack(name, data):
+        match name.split('.')[-1]:
+            case 'json':
+                return json.loads(data)
+            case 'txt':
+                return data.decode() if type(data) is bytes else data
+            case _:
+                return data

zipmanager-0.1.0/zipmanager/__init__.py

@@ -0,0 +1 @@
+from .main import ZipFolder

zipmanager-0.1.0/zipmanager/main.py

@@ -0,0 +1,126 @@
+import io
+import zipfile
+import base64
+
+from .Exceptions import FileNameConflict, ExternalClassOperation, FileNotFound
+from .File import File
+
+
+class ZipFolder:
+
+    def __init__(self, data: dict[str, dict] | dict[str, str] | dict[str, bytes] | str | bytes):
+        match data:
+            case dict():
+                self.__raw_zip = self.__create_zip(data)
+            case str():
+                self.__raw_zip = self.__b64_to_zip(data)
+            case bytes():
+                self.__raw_zip = self.__bytes_to_zip(data)
+
+    def __eq__(self, other):
+        self.__check_class(other)
+        return self.raw_files() == other.raw_files()
+
+    def __add__(self, other):
+        self.__check_class(other)
+        self.add_files(other.raw_files())
+        return self
+
+    def __getitem__(self, file_name):
+        if file_name in self.file_list:
+            return File.unpack(file_name, self.__raw_zip.open(file_name).read())
+        raise FileNotFound(file_name)
+
+    def __str__(self):
+        return (f'Zipfile Object {hex(id(self)).upper()} / '
+                f'file number: {len(self.file_list)} / '
+                f'size: {self.get_size():,} bytes / '
+                f'compressed size: {self.get_size(compressed=True):,} bytes')
+
+    def get_size(self, file_name=None, compressed=False):
+        size = 0
+        match file_name:
+            case str():
+                if file_name in self.file_list:
+                    return getattr(self.__raw_zip.getinfo(file_name), 'compress_size' if compressed else 'file_size')
+                else:
+                    raise FileNotFound(file_name)
+            case _:
+                for file in self.__raw_zip.filelist:
+                    size += getattr(file, 'compress_size' if compressed else 'file_size')
+        return size
+
+    def get(self, file_name):
+        if file_name in self.file_list:
+            return File.unpack(file_name, self.__raw_zip.open(file_name).read())
+        return None
+
+    def add_files(self, data):
+        """
+        add files to the zip file.
+        you can add folders by adding the folder name before the filename separated by a '/'.
+        :param data:            dict of filename as key and data as value
+        :type data:             dict[str, dict] | dict[str, str] | dict[str, bytes]
+        :return:
+        """
+        for file in data.keys():
+            if file in self.file_list:
+                raise FileNameConflict(file)
+        self.__raw_zip = self.__create_zip(dict(self.raw_files(), **data))
+
+    def delete_file(self, file_name):
+        if file_name in self.file_list:
+            self.__raw_zip = self.__edit_zip([file for file in self.file_list if file != file_name])
+
+    def raw_files(self):
+        return {file: File.unpack(file, self.__raw_zip.open(file).read())
+                for file in self.file_list}
+
+    @property
+    def file_list(self):
+        return [file.filename for file in self.__raw_zip.filelist]
+
+    def get_b64(self):
+        return base64.b64encode(self.__edit_zip(byte=True).read()).decode()
+
+    def __check_class(self, other):
+        if type(self) is not type(other):
+            raise ExternalClassOperation(type(other))
+
+    @staticmethod
+    def __create_zip(files):
+        zip_buffer = io.BytesIO()
+        with zipfile.ZipFile(zip_buffer, 'w', zipfile.ZIP_DEFLATED) as file_zip:
+            for file_name, data in files.items():
+                file_zip.writestr(f'{file_name}', data=File.pack(file_name, data))
+        zip_buffer.seek(0)
+        return zipfile.ZipFile(zip_buffer, 'r')
+
+    def __edit_zip(self, files=None, byte=False):
+        if files is None:
+            files = self.file_list
+        zip_buffer = io.BytesIO()
+        with zipfile.ZipFile(zip_buffer, 'w', zipfile.ZIP_DEFLATED) as file_zip:
+            for file_name in files:
+                file_zip.writestr(f'{file_name}', data=File.pack(file_name, self[file_name]))
+        zip_buffer.seek(0)
+        return zipfile.ZipFile(zip_buffer, 'r') if not byte else zip_buffer
+
+    @staticmethod
+    def __bytes_to_zip(data):
+        return zipfile.ZipFile(io.BytesIO(data), 'r')
+
+    @staticmethod
+    def __b64_to_zip(data):
+        return zipfile.ZipFile(io.BytesIO(base64.b64decode(data)), 'r')
+
+    def save(self, path_with_name='./temp.zip'):
+        """
+        saves the zip folder to the given location.
+        path must be with name (extension optional).
+        :param path_with_name:      path for save location (empty will save it to current folder)
+        :type path_with_name:       str
+        :return:
+        """
+        with open(path_with_name if path_with_name.endswith('.zip') else path_with_name + '.zip', 'wb') as zfh:
+            zfh.write(self.__edit_zip(byte=True).read())

zipmanager-0.1.0/zipmanager.egg-info/PKG-INFO

@@ -0,0 +1,74 @@
+Metadata-Version: 2.1
+Name: zipmanager
+Version: 0.1.0
+Summary: Allows you to manage zip folders as data
+Home-page: https://github.com/SimplePythonCoder/zipmanager
+Author: SimplePythonCoder
+Author-email: 
+License: MIT
+Project-URL: Source, https://github.com/SimplePythonCoder/zipmanager
+Project-URL: Issues, https://github.com/SimplePythonCoder/zipmanager/issues
+Keywords: zip
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Topic :: Utilities
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+
+# zipmanager
+## What does this package do ?
+It allows you to create and handle zip folders as data without needing to save them.
+
+## Usage
+```python
+from zipmanager import ZipFolder
+
+file_data = b'some_data'
+
+zip_folder = ZipFolder({'file_name.file_extension': file_data})
+# file extension not required
+# ZipFile will hold all the files given in the dictionary
+
+file_data = zip_folder['file_name.file_extension']
+# will return the file data
+```
+
+## Main functions
+```python
+from zipmanager import ZipFolder
+file_data = b'some_data'
+zip_folder = ZipFolder({'file_name.file_extension': file_data})
+
+# list of functions:
+zip_folder.add_files({'new_file': 'new_data'}) # add files to zip. read more at docstring.
+zip_folder.delete_file('new_file') # removes file from zip
+
+zip_folder.get('file_name') # returns None if file was not found
+# or
+zip_folder['file_name']
+
+zip_folder.save() # saves zip in given location (empty is './temp.zip')
+```
+
+## File extension features
+json and text files data is automatically returned as a dict or str respectively:
+```python
+from zipmanager import ZipFolder
+
+file_data = b'{"key": "value"}'
+
+zip_folder = ZipFolder({'file_name.json': file_data})
+# .json extension is required to return a dict
+
+data = zip_folder['file_name.json']
+# will return a dict type
+
+# same for .txt
+file_data = {'key': 'value'}
+zip_folder = ZipFolder({'file_name.txt': file_data})
+data = zip_folder['file_name.txt']
+# will return a string
+```

zipmanager-0.1.0/zipmanager.egg-info/SOURCES.txt

@@ -0,0 +1,13 @@
+LICENSE
+MANIFEST.in
+README.md
+pyproject.toml
+setup.py
+zipmanager/Exceptions.py
+zipmanager/File.py
+zipmanager/__init__.py
+zipmanager/main.py
+zipmanager.egg-info/PKG-INFO
+zipmanager.egg-info/SOURCES.txt
+zipmanager.egg-info/dependency_links.txt
+zipmanager.egg-info/top_level.txt

zipmanager-0.1.0/zipmanager.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

zipmanager-0.1.0/zipmanager.egg-info/top_level.txt

@@ -0,0 +1 @@
+zipmanager