pullobj 0.1.0__tar.gz

pullobj-0.1.0/.gitignore

@@ -0,0 +1,80 @@
+# Commons
+build/
+bin/
+dist/
+nbdist/
+out/
+target/
+logs/
+*.log
+*.pid
+*.pid.lock
+*.seed
+
+# Java
+*.class
+*.jar
+*.war
+*.nar
+*.ear
+
+# Python
+__pycache__/
+venv/
+*egg-info/
+*.py[cod]
+*.spec
+.python-version
+.venv
+
+# Node
+node_modules/
+jspm_packages/
+web_modules/
+npm-debug.log
+yarn-error.log
+*.tsbuildinfo
+.npm
+
+# Miscellaneous
+.sass-cache/
+**/.angular/cache
+connect.lock
+coverage
+libpeerconnection.log
+testem.log
+typings
+
+# IDE
+tmp/
+.idea/
+.project/
+.settings/
+.classpath/
+.recommenders/
+.vscode/
+.vscode-test/
+.history/
+*.iml
+*.iws
+*.tmp
+*.bak
+*.swp
+*~.nib
+*.pydevproject
+.cproject
+.project
+.metadata
+.loadpath
+.buildpath
+
+# System
+.DS_Store
+Thumbs.db
+
+# Local
+local.properties
+local.ini
+local.json
+.env
+output/

pullobj-0.1.0/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2026 cvisinoni
+
+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.

pullobj-0.1.0/PKG-INFO

@@ -0,0 +1,77 @@
+Metadata-Version: 2.4
+Name: pullobj
+Version: 0.1.0
+Summary: A Python library for synchronizing remote objects to local files
+Project-URL: Homepage, https://github.com/cvisinoni/pullobj
+Project-URL: Issues, https://github.com/cvisinoni/pullobj/issues
+Author: cvisinoni
+License: Copyright (c) 2026 cvisinoni
+        
+        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.
+License-File: LICENSE
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+
+# pullobj
+[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/cvisinoni/pullobj/blob/master/LICENSE)
+
+pullobj is a Python library for building clients that connect to a generic remote server 
+(databases, cloud storage, object collections) and synchronize all remote objects to a local directory.
+It provides a simple abstraction to keep a local mirror always up to date with the remote source.
+
+
+## Features
+- Generic client for remote servers
+- Full download of remote objects to local storage
+- On-demand synchronization (remote → local)
+- Supports heterogeneous objects (JSON, Excel, images, code, etc.)
+- Extensible design for custom backends
+
+
+## Installation
+```bash
+pip install pullobj
+```
+
+## Core Concept
+- A Client represents a remote source
+- The client knows how to list and fetch remote objects
+- pullobj handles local storage and synchronization logic
+
+
+## Contributing
+If you'd like to contribute to pullobj, feel free to fork this repository, 
+make your changes, and submit a pull request. 
+We welcome contributions of all kinds, whether it's fixing a bug, 
+adding a new feature, or improving documentation.
+
+
+## License
+This project is MIT licensed. See the [LICENSE](LICENSE) file for details.
+
+
+## Support
+If you have any questions, issues, or suggestions regarding pullobj, 
+please [open an issue](https://github.com/cvisinoni/pullobj/issues) on GitHub.
+We'd love to hear from you!

pullobj-0.1.0/README.md

@@ -0,0 +1,42 @@
+# pullobj
+[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/cvisinoni/pullobj/blob/master/LICENSE)
+
+pullobj is a Python library for building clients that connect to a generic remote server 
+(databases, cloud storage, object collections) and synchronize all remote objects to a local directory.
+It provides a simple abstraction to keep a local mirror always up to date with the remote source.
+
+
+## Features
+- Generic client for remote servers
+- Full download of remote objects to local storage
+- On-demand synchronization (remote → local)
+- Supports heterogeneous objects (JSON, Excel, images, code, etc.)
+- Extensible design for custom backends
+
+
+## Installation
+```bash
+pip install pullobj
+```
+
+## Core Concept
+- A Client represents a remote source
+- The client knows how to list and fetch remote objects
+- pullobj handles local storage and synchronization logic
+
+
+## Contributing
+If you'd like to contribute to pullobj, feel free to fork this repository, 
+make your changes, and submit a pull request. 
+We welcome contributions of all kinds, whether it's fixing a bug, 
+adding a new feature, or improving documentation.
+
+
+## License
+This project is MIT licensed. See the [LICENSE](LICENSE) file for details.
+
+
+## Support
+If you have any questions, issues, or suggestions regarding pullobj, 
+please [open an issue](https://github.com/cvisinoni/pullobj/issues) on GitHub.
+We'd love to hear from you!

pullobj-0.1.0/pullobj/__init__.py

@@ -0,0 +1,8 @@
+from .client import Client
+from .element import Element
+
+
+__all__ = [
+    'Client',
+    'Element',
+]

pullobj-0.1.0/pullobj/client.py

@@ -0,0 +1,69 @@
+from .element import Element
+from .utils import load_json, save_json
+from .logger import log
+from os import walk, listdir, rmdir
+from pathlib import Path
+
+
+class Client:
+
+    def __init__(self, root: str | Path):
+        self.root = Path(root)
+        self.objectsinfo = dict()
+        self.element_class = type[Element](
+            Element.__name__, (Element,), dict(root=self.root)
+        )
+
+    @property
+    def objectsinfo_file(self):
+        return self.root / '.objectsinfo.json'
+
+    def load_objectsinfo(self):
+        if self.objectsinfo_file.exists():
+            content = load_json(self.objectsinfo_file)
+            for key, data in content.items():
+                element = self.element_class.from_dict(data)
+                self.objectsinfo[key] = element
+
+    def save_objectsinfo(self):
+        save_json(self.objectsinfo_file, {
+            key: element.to_dict() for key, element in self.objectsinfo.items()
+        })
+
+    def retrieve_elements_dict(self):
+        raise NotImplementedError('Not implemented')
+
+    def retrieve_an_element_content(self, element: Element):
+        raise NotImplementedError('Not implemented')
+
+    def pull(self):
+        log.debug(f'--- start pull elements for client {self.root} ---')
+        # load old objectsinfo and retrieve new dict
+        self.load_objectsinfo()
+        elements_dict = self.retrieve_elements_dict()
+
+        # delete elements that are not in the new dict
+        for key, element in list(self.objectsinfo.items()):
+            if key not in elements_dict:
+                element.delete()
+                self.objectsinfo.pop(key)
+
+        # delete empty folders
+        walk_list = list(walk(self.root))
+        for top, dirs, files in walk_list[::-1]:
+            if len(listdir(top)) == 0:
+                rmdir(top)
+
+        # export elements that are in the new dict
+        for key, value in elements_dict.items():
+            new_element: Element = self.element_class.from_dict(value)
+            if key in self.objectsinfo:
+                old_element = self.objectsinfo[key]
+                if old_element.last_update_date >= new_element.last_update_date and old_element.file.is_file():
+                    continue
+            content = self.retrieve_an_element_content(new_element)
+            new_element.save(content)
+            self.objectsinfo[key] = new_element
+
+        # update file objectsinfo
+        self.save_objectsinfo()

pullobj-0.1.0/pullobj/element.py

@@ -0,0 +1,55 @@
+from .logger import log
+from datetime import datetime
+from pathlib import Path
+from copy import deepcopy
+import os
+
+
+class Element:
+
+    root: Path = None
+
+    def __init__(self, key: str, path: str, last_update_date: datetime, **kwargs):
+        self.key = key
+        self.path = path if not path.startswith('/') else path[1:]
+        self.last_update_date = last_update_date
+        self.kwargs = kwargs
+
+    @classmethod
+    def from_dict(cls, data: dict):
+        kwargs = deepcopy(data)
+        key = kwargs.pop('key')
+        path = kwargs.pop('path')
+        last_update_date = kwargs.pop('last_update_date')
+        if isinstance(last_update_date, str):
+            last_update_date = datetime.fromisoformat(last_update_date)
+        return cls(key, path, last_update_date, **kwargs)
+
+    @property
+    def file(self):
+        return self.root / self.path
+
+    def to_dict(self):
+        result = dict(
+            key=self.key,
+            path=self.path,
+            last_update_date=self.last_update_date.isoformat(),
+        )
+        for key, value in self.kwargs.items():
+            result[key] = value
+        return result
+
+    def delete(self):
+        if self.file.is_file():
+            log.debug(f'deleting {self.file}')
+            os.remove(self.file)
+
+    def save(self, content: str | bytes):
+        if isinstance(content, str):
+            content = content.encode('utf-8')
+        if isinstance(content, bytes):
+            log.debug(f'saving {self.file}')
+            self.file.parent.mkdir(parents=True, exist_ok=True)
+            self.file.write_bytes(content)
+        else:
+            log.warning(f'content of {self.key} is not str or bytes ({type(content)})')

pullobj-0.1.0/pullobj/logger.py

@@ -0,0 +1,4 @@
+import logging
+
+
+log = logging.getLogger(__package__)

pullobj-0.1.0/pullobj/utils.py

@@ -0,0 +1,13 @@
+from pathlib import Path
+import json
+
+
+def load_json(file: Path) -> dict | list:
+    with open(file, mode='r', encoding='utf-8') as fp:
+        return json.load(fp)
+
+
+def save_json(file: Path, data: dict | list):
+    Path(file).parent.mkdir(parents=True, exist_ok=True)
+    with open(file, mode='w', encoding='utf-8') as fp:
+        json.dump(data, fp, indent='    ')

pullobj-0.1.0/pyproject.toml

@@ -0,0 +1,30 @@
+[build-system]
+
+requires = ["hatchling>=1.26"]
+build-backend = "hatchling.build"
+
+
+[project]
+
+name = "pullobj"
+version = "0.1.0"
+authors = [{ name = "cvisinoni" }]
+description = "A Python library for synchronizing remote objects to local files"
+readme = { file = "README.md", content-type = "text/markdown" }
+requires-python = ">=3.9"
+license = { file = "LICENSE" }
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Operating System :: OS Independent",
+]
+
+
+[project.urls]
+
+Homepage = "https://github.com/cvisinoni/pullobj"
+Issues = "https://github.com/cvisinoni/pullobj/issues"
+
+
+[tool.hatch.build]
+
+exclude = ["tests/**", "*.pyc", ".github/**", '/example.py']