compas-pb 0.1.0__tar.gz

compas_pb-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Gramazio Kohler Research
+
+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.

compas_pb-0.1.0/PKG-INFO

@@ -0,0 +1,139 @@
+Metadata-Version: 2.4
+Name: compas_pb
+Version: 0.1.0
+Summary: Protobuf extension for COMPAS Data
+Author-email: Wei-Ting Chen <chenwei@arch.ethz.ch>, Chen Kasirer <kasirer@arch.ethz.ch>
+License: MIT License
+        
+        Gramazio Kohler Research
+        
+        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.
+        
+Project-URL: Homepage, https://gramaziokohler.github.io/compas_pb
+Project-URL: Documentation, https://gramaziokohler.github.io/compas_pb
+Project-URL: Repository, https://github.com/gramaziokohler/compas_pb
+Project-URL: Changelog, https://github.com/gramaziokohler/compas_pb/blob/main/CHANGELOG.md
+Project-URL: Issues, https://github.com/gramaziokohler/compas_pb/issues
+Project-URL: Forum, https://forum.compas-framework.org/
+Classifier: Development Status :: 4 - Beta
+Classifier: Topic :: Scientific/Engineering
+Classifier: Operating System :: Unix
+Classifier: Operating System :: POSIX
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: compas>=2
+Requires-Dist: protobuf>=6.31.1
+Provides-Extra: dev
+Requires-Dist: attrs>=17.4; extra == "dev"
+Requires-Dist: black>=22.12.0; extra == "dev"
+Requires-Dist: bump-my-version; extra == "dev"
+Requires-Dist: compas_invocations2; extra == "dev"
+Requires-Dist: invoke>=0.14; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
+Requires-Dist: sphinx_compas2_theme; extra == "dev"
+Requires-Dist: twine; extra == "dev"
+Requires-Dist: wheel; extra == "dev"
+Requires-Dist: pytest-mock; extra == "dev"
+Requires-Dist: build; extra == "dev"
+Dynamic: license-file
+
+# compas_pb
+
+A COMPAS extension which lets you serialize and deserialize COMPAS `Data` types using protobuf.
+
+## Installation
+
+Stable releases can be installed from PyPI.
+
+```bash
+pip install compas_pb
+```
+
+## Basic Usage
+
+### Serialize to file
+
+```python
+from compas.geometry import Vector
+from compas_pb import pb_dump
+from compas_pb import pb_load
+
+PATH = "vector.data"
+
+vector = Vector(1.0, 2.0, 3.0)
+
+pb_dump(vector, PATH)
+
+loaded_vector = pb_load(PATH)
+
+```
+
+### (De)serialize to bytes
+
+```python
+from compas.geometry import Vector
+from compas_pb import pb_dump_bts
+from compas_pb import pb_load_bts
+
+vector = Vector(1.0, 2.0, 3.0)
+
+bytes_vector = pb_dump_bts(vector)
+
+loaded_vector = pb_load_bts(bytes_vector)
+
+```
+
+### Serialization of arbitrarily nested data structures
+
+```python
+from compas.geometry import Vector
+from compas.geometry import Polyline
+from compas_pb import pb_dump_bts
+from compas_pb import pb_load_bts
+
+data = {
+    "direction": Vector(1.0, 2.0, 3.0),
+    "outlines": 
+        [
+            Polyline([0, 0, 0], [1, 1, 1], [2, 2, 2]), 
+            Polyline([3, 3, 3], [4, 4, 4], [5, 5, 5])
+        ],
+}
+
+pb_data = pb_dump_bts(data)
+
+loaded_data = pb_load_bts(pb_data)
+
+```
+
+## Documentation
+
+For further "getting started" instructions, a tutorial, examples, and an API reference,
+please check out the online documentation here: [compas_pb docs](https://gramaziokohler.github.io/compas_pb)
+
+## Issue Tracker
+
+If you find a bug or if you have a problem with running the code, please file an issue on the [Issue Tracker](https://github.com/gramaziokohler/compas_pb/issues).

compas_pb-0.1.0/README.md

@@ -0,0 +1,77 @@
+# compas_pb
+
+A COMPAS extension which lets you serialize and deserialize COMPAS `Data` types using protobuf.
+
+## Installation
+
+Stable releases can be installed from PyPI.
+
+```bash
+pip install compas_pb
+```
+
+## Basic Usage
+
+### Serialize to file
+
+```python
+from compas.geometry import Vector
+from compas_pb import pb_dump
+from compas_pb import pb_load
+
+PATH = "vector.data"
+
+vector = Vector(1.0, 2.0, 3.0)
+
+pb_dump(vector, PATH)
+
+loaded_vector = pb_load(PATH)
+
+```
+
+### (De)serialize to bytes
+
+```python
+from compas.geometry import Vector
+from compas_pb import pb_dump_bts
+from compas_pb import pb_load_bts
+
+vector = Vector(1.0, 2.0, 3.0)
+
+bytes_vector = pb_dump_bts(vector)
+
+loaded_vector = pb_load_bts(bytes_vector)
+
+```
+
+### Serialization of arbitrarily nested data structures
+
+```python
+from compas.geometry import Vector
+from compas.geometry import Polyline
+from compas_pb import pb_dump_bts
+from compas_pb import pb_load_bts
+
+data = {
+    "direction": Vector(1.0, 2.0, 3.0),
+    "outlines": 
+        [
+            Polyline([0, 0, 0], [1, 1, 1], [2, 2, 2]), 
+            Polyline([3, 3, 3], [4, 4, 4], [5, 5, 5])
+        ],
+}
+
+pb_data = pb_dump_bts(data)
+
+loaded_data = pb_load_bts(pb_data)
+
+```
+
+## Documentation
+
+For further "getting started" instructions, a tutorial, examples, and an API reference,
+please check out the online documentation here: [compas_pb docs](https://gramaziokohler.github.io/compas_pb)
+
+## Issue Tracker
+
+If you find a bug or if you have a problem with running the code, please file an issue on the [Issue Tracker](https://github.com/gramaziokohler/compas_pb/issues).

compas_pb-0.1.0/pyproject.toml

@@ -0,0 +1,149 @@
+[build-system]
+requires = ["setuptools>=66.0"]
+build-backend = "setuptools.build_meta"
+
+# ============================================================================
+# project info
+# ============================================================================
+
+[project]
+name = "compas_pb"
+description = "Protobuf extension for COMPAS Data"
+keywords = []
+authors = [
+    { name = "Wei-Ting Chen", email = "chenwei@arch.ethz.ch" },
+    { name = "Chen Kasirer", email = "kasirer@arch.ethz.ch" }
+]
+license = { file = "LICENSE" }
+readme = "README.md"
+requires-python = ">=3.9"
+dynamic = ['dependencies', 'optional-dependencies', 'version']
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Topic :: Scientific/Engineering",
+    "Operating System :: Unix",
+    "Operating System :: POSIX",
+    "Operating System :: Microsoft :: Windows",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+]
+
+[project.urls]
+Homepage = "https://gramaziokohler.github.io/compas_pb"
+Documentation = "https://gramaziokohler.github.io/compas_pb"
+Repository = "https://github.com/gramaziokohler/compas_pb"
+Changelog = "https://github.com/gramaziokohler/compas_pb/blob/main/CHANGELOG.md"
+Issues = "https://github.com/gramaziokohler/compas_pb/issues"
+Forum = "https://forum.compas-framework.org/"
+
+# ============================================================================
+# setuptools config
+# ============================================================================
+
+[tool.setuptools]
+package-dir = { "" = "src" }
+include-package-data = true
+zip-safe = false
+
+[tool.setuptools.dynamic]
+version = { attr = "compas_pb.__version__" }
+dependencies = { file = "requirements.txt" }
+optional-dependencies = { dev = { file = "requirements-dev.txt" } }
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+# ============================================================================
+# replace pytest.ini
+# ============================================================================
+
+[tool.pytest.ini_options]
+minversion = "6.0"
+testpaths = ["tests", "src/compas_pb"]
+python_files = ["test_*.py", "*_test.py", "test.py"]
+addopts = [
+    "-ra",
+    "--strict-markers",
+    "--doctest-glob=*.rst",
+    "--tb=short",
+    "--import-mode=importlib",
+]
+doctest_optionflags = [
+    "NORMALIZE_WHITESPACE",
+    "IGNORE_EXCEPTION_DETAIL",
+    "ALLOW_UNICODE",
+    "ALLOW_BYTES",
+    "NUMBER",
+]
+
+# ============================================================================
+# replace bumpversion.cfg
+# ============================================================================
+
+[tool.bumpversion]
+current_version = "0.1.0"
+message = "Bump version to {new_version}"
+commit = true
+tag = true
+
+[[tool.bumpversion.files]]
+filename = "src/compas_pb/__init__.py"
+search = "{current_version}"
+replace = "{new_version}"
+
+[[tool.bumpversion.files]]
+filename = "CHANGELOG.md"
+search = "Unreleased"
+replace = "[{new_version}] {now:%Y-%m-%d}"
+
+# ============================================================================
+# linting and formatting
+# ============================================================================
+
+[tool.black]
+extend-exclude = '(/[a-zA-Z\./]*[\s]?)'  # exclude everything, black should be removed..
+
+[tool.ruff]
+line-length = 179
+indent-width = 4
+target-version = "py39"
+exclude = ["src/compas_pb/generated/"]
+
+[tool.ruff.lint]
+select = ["E", "F", "I"]
+
+[tool.ruff.lint.per-file-ignores]
+"__init__.py" = ["I001"]
+"tests/*" = ["I001"]
+"tasks.py" = ["I001"]
+
+[tool.isort]
+line_length = 179
+multi_line_output = 3
+include_trailing_comma = true
+force_grid_wrap = 0
+use_parentheses = true
+force_single_line = false
+ensure_newline_before_comments = true
+known_first_party = "compas_pb"
+default_section = "THIRDPARTY"
+
+forced_separate = "test_compas_pb"
+
+[tool.ruff.lint.isort]
+force-single-line = true
+known-first-party = ["compas_pb"]
+
+[tool.ruff.lint.pydocstyle]
+convention = "numpy"
+
+[tool.ruff.lint.pycodestyle]
+max-doc-length = 179
+
+[tool.ruff.format]
+docstring-code-format = true
+docstring-code-line-length = "dynamic"
+

compas_pb-0.1.0/requirements-dev.txt

@@ -0,0 +1,11 @@
+attrs >=17.4
+black >=22.12.0
+bump-my-version
+compas_invocations2
+invoke >=0.14
+ruff
+sphinx_compas2_theme
+twine
+wheel
+pytest-mock
+build

compas_pb-0.1.0/requirements.txt

@@ -0,0 +1,2 @@
+compas >= 2
+protobuf >=6.31.1

compas_pb-0.1.0/setup.cfg

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

compas_pb-0.1.0/src/compas_pb/__init__.py

@@ -0,0 +1,43 @@
+from __future__ import print_function
+
+import os
+
+# please don't remove me! I trigger the registration of all the core serializers
+import compas_pb.conversions  # noqa: F401  #
+
+from .api import pb_load
+from .api import pb_dump
+from .api import pb_dump_bts
+from .api import pb_load_bts
+from .api import pb_dump_json
+from .api import pb_load_json
+
+
+__author__ = ["Wei-Ting Chen", "Chen Kasirer"]
+__copyright__ = "Gramazio Kohler Research"
+__license__ = "MIT License"
+__email__ = "kasirer@arch.ethz.ch"
+__version__ = "0.1.0"
+
+
+HERE = os.path.dirname(__file__)
+
+HOME = os.path.abspath(os.path.join(HERE, "../../"))
+DATA = os.path.abspath(os.path.join(HOME, "data"))
+DOCS = os.path.abspath(os.path.join(HOME, "docs"))
+TEMP = os.path.abspath(os.path.join(HOME, "temp"))
+IDL = os.path.abspath(os.path.join(HOME, "IDL"))
+
+__all__ = [
+    "HOME",
+    "DATA",
+    "DOCS",
+    "TEMP",
+    "IDL",
+    "pb_load",
+    "pb_dump",
+    "pb_dump_bts",
+    "pb_load_bts",
+    "pb_dump_json",
+    "pb_load_json",
+]

compas_pb-0.1.0/src/compas_pb/api.py

@@ -0,0 +1,155 @@
+from typing import Dict
+from typing import List
+
+from compas.data import Data
+
+from compas_pb.core import deserialize_message
+from compas_pb.core import deserialize_message_from_json
+from compas_pb.core import serialize_message_bts
+from compas_pb.core import serialize_message_to_json
+
+
+def pb_dump(data: Data | Dict[str, Data] | List[Data], filepath: str) -> None:
+    """Write a collection of COMPAS object to a binary file.
+
+    Parameters
+    ----------
+    data : Data | Dict | List
+        Any  protobuffer serializable object.
+        This includes any (combination of) COMPAS object(s).
+    filepath : path string or file-like object
+        A writeable file-like object or the path to a file.
+
+    Returns:
+    -------
+    None
+
+    Example:
+    --------
+    pass
+
+    """
+    message_bts = serialize_message_bts(data)
+
+    with open(filepath, "wb") as f:
+        f.write(message_bts)
+
+
+def pb_load(filepath: str) -> Data | Dict | List:
+    """Read a collection of COMPAS object from a binary file.
+
+    Parameters
+    ----------
+    filepath : path string or file-like object
+
+        A readable file-like object or the path to a file.
+
+    Returns:
+    -------
+    Data | Dict | List
+
+        The (COMPAS) object(s) contained in the file.
+
+    """
+
+    with open(filepath, "rb") as f:
+        message_bts = f.read()
+        message = deserialize_message(message_bts)
+        return message
+
+
+def pb_dump_json(data: Data | Dict | List) -> str:
+    """Write a collection of COMPAS object to a JSON string.
+
+
+    Parameters
+    ----------
+    data : Data | Dict | List
+
+        Any  protobuffer serializable object. This includes any (combination of) COMPAS object(s).
+
+
+    Returns:
+    -------
+    string
+
+        The JSON string representation of the data.
+
+    Example:
+    --------
+    pass
+
+    """
+    json_str = serialize_message_to_json(data)
+    return json_str
+
+
+def pb_load_json(data: str) -> Data | Dict | List:
+    """Read a collection of COMPAS object from a JSON string.
+
+
+    Parameters
+    ----------
+    data : str
+
+        A JSON string representation of the data.
+
+
+    Returns:
+    -------
+    Data | Dict | List
+
+
+        The (COMPAS) object(s) contained in the JSON string.
+
+    Example:
+    --------
+    pass
+
+    """
+    message = deserialize_message_from_json(data)
+    return message
+
+
+def pb_dump_bts(data: Data | Dict | list) -> bytes:
+    """Write a collection of COMPAS object to a btye string.
+
+
+    Parameters
+    ----------
+    data : Data | Dict | List
+
+        Any  protobuffer serializable object.
+        This includes any (combination of) COMPAS object(s).
+
+    Returns:
+    -------
+    None
+
+    Example:
+    --------
+    pass
+
+    """
+    message_bts = serialize_message_bts(data)
+
+    return message_bts
+
+
+def pb_load_bts(data: bytes) -> Data | Dict | List:
+    """Read a collection of COMPAS object from a binary file.
+
+    Parameters
+    ----------
+    filepath : path string or file-like object
+        A readable file-like object or the path to a file.
+
+
+    Returns:
+    -------
+    Data | Dict | List
+        The (COMPAS) object(s) contained in the file.
+
+    """
+    message_bts = deserialize_message(data)
+    return message_bts