bw-processing 0.8.5__tar.gz → 0.9.5__tar.gz

bw_processing-0.9.5/MANIFEST.in

@@ -0,0 +1,3 @@
+include bw_processing/examples/*.zip
+include bw_processing/examples/datapackage_1/*.parquet
+recursive-exclude dev *

{bw-processing-0.8.5/bw_processing.egg-info → bw_processing-0.9.5}/PKG-INFO

@@ -1,31 +1,42 @@
 Metadata-Version: 2.1
-Name: bw-processing
-Version: 0.8.5
-Summary: Tools to create structured arrays in a common format
-Home-page: https://github.com/brightway-lca/bw_processing
-Author: Chris Mutel
-Author-email: <cmutel@gmail.com>
-Maintainer: Chris Mutel
-Maintainer-email: <cmutel@gmail.com>
-License: BSD-3-Clause
+Name: bw_processing
+Version: 0.9.5
+Summary: Foo
+Author-email: Chris Mutel <cmutel@gmail.com>
+Maintainer-email: Chris Mutel <cmutel@gmail.com>
 Project-URL: source, https://github.com/brightway-lca/bw_processing
 Project-URL: homepage, https://github.com/brightway-lca/bw_processing
 Project-URL: tracker, https://github.com/brightway-lca/bw_processing/issues
-Keywords: "brightway","development"
-Platform: any
 Classifier: Development Status :: 4 - Beta
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
-Requires-Python: >=3.8
-Description-Content-Type: text/markdown; charset=UTF-8
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
+Classifier: Topic :: Scientific/Engineering
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: fsspec
+Requires-Dist: morefs
+Requires-Dist: numpy
+Requires-Dist: pandas
 Provides-Extra: testing
+Requires-Dist: bw_processing; extra == "testing"
+Requires-Dist: pytest; extra == "testing"
+Requires-Dist: pytest-cov; extra == "testing"
+Requires-Dist: python-coveralls; extra == "testing"
 Provides-Extra: dev
-Provides-Extra: docs
-License-File: LICENSE
+Requires-Dist: build; extra == "dev"
+Requires-Dist: pre-commit; extra == "dev"
+Requires-Dist: pylint; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"
+Requires-Dist: pytest-randomly; extra == "dev"
+Requires-Dist: setuptools; extra == "dev"
 
 # bw-processing
 
@@ -34,10 +45,10 @@ Library for storing numeric data for use in matrix-based calculations. Designed
 [![PyPI](https://img.shields.io/pypi/v/bw-processing.svg)][pypi status]
 [![Status](https://img.shields.io/pypi/status/bw-processing.svg)][pypi status]
 [![Python Version](https://img.shields.io/pypi/pyversions/bw-processing)][pypi status]
-[![License](https://img.shields.io/pypi/l/bw-processing)][license]
+[![License](https://img.shields.io/pypi/l/bw_processing)][license]
 
 [![Read the documentation at https://bw-processing.readthedocs.io/](https://img.shields.io/readthedocs/bw-processing/latest.svg?label=Read%20the%20Docs)][read the docs]
-[![Tests](https://github.com/brightway-lca/bw-processing/actions/workflows/python-test.yml/badge.svg)][tests]
+[![Testing](https://github.com/brightway-lca/bw_processing/actions/workflows/python-test.yml/badge.svg)][tests]
 [![Codecov](https://codecov.io/gh/brightway-lca/bw-processing/branch/main/graph/badge.svg)][codecov]
 
 [![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)][pre-commit]
@@ -45,7 +56,7 @@ Library for storing numeric data for use in matrix-based calculations. Designed
 
 [pypi status]: https://pypi.org/project/bw-processing/
 [read the docs]: https://bw-processing.readthedocs.io/
-[tests]: https://github.com/brightway-lca/bw-processing/actions?workflow=Tests
+[tests]: https://github.com/brightway-lca/bw_processing/actions/workflows/python-test.yml
 [codecov]: https://app.codecov.io/gh/brightway-lca/bw-processing
 [pre-commit]: https://github.com/pre-commit/pre-commit
 [black]: https://github.com/psf/black
@@ -136,10 +147,10 @@ class ExampleArrayInterface:
 Serialized datapackages cannot contain executable code, both because of our chosen data formats, and for security reasons. Therefore, when loading a datapackage with an interface, that interface object needs to be reconstituted as Python code - we call this cycle dehydration and rehydration. Dehydration happens automatically when a datapackage is finalized with `finalize_serialization()`, but rehydration needs to be done manually using `rehydrate_interface()`. For example:
 
 ```python
-from fs.zipfs import ZipFS
+from fsspec.implementations.zip import ZipFileSystem
 from bw_processing import load_datapackage
 
-my_dp = load_datapackage(ZipFS("some-path.zip"))
+my_dp = load_datapackage(ZipFileSystem("some-path.zip"))
 my_dp.rehydrate_interface("some-resource-name", ExampleVectorInterface())
 ```
 
@@ -148,7 +159,7 @@ You can list the dehydrated interfaces present with `.dehydrated_interfaces()`.
 You can store useful information for the interface object initialization under the resource key `config`. This can be used in instantiating an interface if you pass `initialize_with_config`:
 
 ```python
-from fs.zipfs import ZipFS
+from fsspec.implementations.zip import ZipFileSystem
 from bw_processing import load_datapackage
 import requests
 import numpy as np
@@ -162,7 +173,7 @@ class MyInterface:
         return np.array(requests.get(self.url).json())
 
 
-my_dp = load_datapackage(ZipFS("some-path.zip"))
+my_dp = load_datapackage(ZipFileSystem("some-path.zip"))
 data_obj, resource_metadata = my_dp.get_resource("some-interface")
 print(resource_metadata['config'])
 >>> {"url": "example.com"}

{bw-processing-0.8.5 → bw_processing-0.9.5}/README.md

@@ -5,10 +5,10 @@ Library for storing numeric data for use in matrix-based calculations. Designed
 [![PyPI](https://img.shields.io/pypi/v/bw-processing.svg)][pypi status]
 [![Status](https://img.shields.io/pypi/status/bw-processing.svg)][pypi status]
 [![Python Version](https://img.shields.io/pypi/pyversions/bw-processing)][pypi status]
-[![License](https://img.shields.io/pypi/l/bw-processing)][license]
+[![License](https://img.shields.io/pypi/l/bw_processing)][license]
 
 [![Read the documentation at https://bw-processing.readthedocs.io/](https://img.shields.io/readthedocs/bw-processing/latest.svg?label=Read%20the%20Docs)][read the docs]
-[![Tests](https://github.com/brightway-lca/bw-processing/actions/workflows/python-test.yml/badge.svg)][tests]
+[![Testing](https://github.com/brightway-lca/bw_processing/actions/workflows/python-test.yml/badge.svg)][tests]
 [![Codecov](https://codecov.io/gh/brightway-lca/bw-processing/branch/main/graph/badge.svg)][codecov]
 
 [![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)][pre-commit]
@@ -16,7 +16,7 @@ Library for storing numeric data for use in matrix-based calculations. Designed
 
 [pypi status]: https://pypi.org/project/bw-processing/
 [read the docs]: https://bw-processing.readthedocs.io/
-[tests]: https://github.com/brightway-lca/bw-processing/actions?workflow=Tests
+[tests]: https://github.com/brightway-lca/bw_processing/actions/workflows/python-test.yml
 [codecov]: https://app.codecov.io/gh/brightway-lca/bw-processing
 [pre-commit]: https://github.com/pre-commit/pre-commit
 [black]: https://github.com/psf/black
@@ -107,10 +107,10 @@ class ExampleArrayInterface:
 Serialized datapackages cannot contain executable code, both because of our chosen data formats, and for security reasons. Therefore, when loading a datapackage with an interface, that interface object needs to be reconstituted as Python code - we call this cycle dehydration and rehydration. Dehydration happens automatically when a datapackage is finalized with `finalize_serialization()`, but rehydration needs to be done manually using `rehydrate_interface()`. For example:
 
 ```python
-from fs.zipfs import ZipFS
+from fsspec.implementations.zip import ZipFileSystem
 from bw_processing import load_datapackage
 
-my_dp = load_datapackage(ZipFS("some-path.zip"))
+my_dp = load_datapackage(ZipFileSystem("some-path.zip"))
 my_dp.rehydrate_interface("some-resource-name", ExampleVectorInterface())
 ```
 
@@ -119,7 +119,7 @@ You can list the dehydrated interfaces present with `.dehydrated_interfaces()`.
 You can store useful information for the interface object initialization under the resource key `config`. This can be used in instantiating an interface if you pass `initialize_with_config`:
 
 ```python
-from fs.zipfs import ZipFS
+from fsspec.implementations.zip import ZipFileSystem
 from bw_processing import load_datapackage
 import requests
 import numpy as np
@@ -133,7 +133,7 @@ class MyInterface:
         return np.array(requests.get(self.url).json())
 
 
-my_dp = load_datapackage(ZipFS("some-path.zip"))
+my_dp = load_datapackage(ZipFileSystem("some-path.zip"))
 data_obj, resource_metadata = my_dp.get_resource("some-interface")
 print(resource_metadata['config'])
 >>> {"url": "example.com"}

{bw-processing-0.8.5 → bw_processing-0.9.5}/bw_processing/__init__.py

@@ -15,6 +15,7 @@ __all__ = (
     "generic_zipfile_filesystem",
     "INDICES_DTYPE",
     "load_datapackage",
+    "MatrixSerializeFormat",
     "md5",
     "merge_datapackages_with_mask",
     "reindex",
@@ -25,11 +26,11 @@ __all__ = (
     "UndefinedInterface",
 )
 
-__version__ = "0.8.5"
+__version__ = "0.9.5"
 
 
 from .array_creation import create_array, create_structured_array
-from .constants import DEFAULT_LICENSES, INDICES_DTYPE, UNCERTAINTY_DTYPE
+from .constants import DEFAULT_LICENSES, INDICES_DTYPE, UNCERTAINTY_DTYPE, MatrixSerializeFormat
 from .datapackage import (
     Datapackage,
     DatapackageBase,

{bw-processing-0.8.5 → bw_processing-0.9.5}/bw_processing/array_creation.py

@@ -68,7 +68,8 @@ def create_structured_array(iterable, dtype, nrows=None, sort=False, sort_fields
 
     ``iterable`` can be data already in memory, or a generator.
 
-    ``nrows`` can be supplied, if known. If ``iterable`` has a length, it will be determined automatically. If ``nrows`` is not known, this function generates chunked arrays until ``iterable`` is exhausted, and concatenates them."""
+    ``nrows`` can be supplied, if known. If ``iterable`` has a length, it will be determined automatically. If ``nrows`` is not known, this function generates chunked arrays until ``iterable`` is exhausted, and concatenates them.
+    """
     if nrows or hasattr(iterable, "__len__"):
         if not nrows:
             nrows = len(iterable)

{bw-processing-0.8.5 → bw_processing-0.9.5}/bw_processing/constants.py

@@ -1,4 +1,5 @@
 import re
+from enum import Enum
 
 import numpy as np
 
@@ -30,3 +31,19 @@ DEFAULT_LICENSES = [
         "title": "Open Data Commons Public Domain Dedication and License v1.0",
     }
 ]
+
+
+class MatrixSerializeFormat(str, Enum):
+    """
+    Enum with the serializing formats for the vectors and matrices.
+    """
+
+    NUMPY = "numpy"  # numpy .npy format
+    PARQUET = "parquet"  # Apache .parquet format
+
+
+# FILE EXTENSIONS
+NUMPY_SERIALIZE_FORMAT_EXTENSION = ".npy"
+NUMPY_SERIALIZE_FORMAT_NAME = "npy"
+PARQUET_SERIALIZE_FORMAT_EXTENSION = ".parquet"
+PARQUET_SERIALIZE_FORMAT_NAME = "pqt"