bw-processing 0.9__tar.gz → 0.9.2__tar.gz

{bw-processing-0.9/bw_processing.egg-info → bw_processing-0.9.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: bw-processing
-Version: 0.9
+Version: 0.9.2
 Summary: Tools to create structured arrays in a common format
 Home-page: https://github.com/brightway-lca/bw_processing
 Author: Chris Mutel
@@ -46,10 +46,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]
@@ -57,7 +57,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

{bw-processing-0.9 → bw_processing-0.9.2}/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

{bw-processing-0.9 → bw_processing-0.9.2}/bw_processing/__init__.py

@@ -26,7 +26,7 @@ __all__ = (
     "UndefinedInterface",
 )
 
-__version__ = "0.9"
+__version__ = "0.9.2"
 
 
 from .array_creation import create_array, create_structured_array

{bw-processing-0.9 → bw_processing-0.9.2}/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.9 → bw_processing-0.9.2}/bw_processing/datapackage.py

@@ -31,7 +31,7 @@ from .errors import (
 from .filesystem import clean_datapackage_name
 from .io_helpers import file_reader, file_writer
 from .proxies import Proxy, UndefinedInterface
-from .utils import check_name, check_suffix, load_bytes, resolve_dict_iterator
+from .utils import check_name, check_suffix, load_bytes, resolve_dict_iterator, utc_now
 
 
 class DatapackageBase(ABC):
@@ -127,7 +127,8 @@ class DatapackageBase(ABC):
     def del_resource_group(self, name: str) -> None:
         """Remove a resource group, and delete its data files, if any.
 
-        Use ``exclude_resource_group`` if you want to keep the underlying resource in the filesystem."""
+        Use ``exclude_resource_group`` if you want to keep the underlying resource in the filesystem.
+        """
         if self._modified:
             raise PotentialInconsistency(
                 "Datapackage is modified; save modifications or reload"
@@ -181,7 +182,8 @@ class DatapackageBase(ABC):
 
         All included objects are the same as in the original data package, i.e. no copies are made. No checks are made to ensure consistency with modifications to the original datapackage after the creation of this filtered datapackage.
 
-        This method was introduced to allow for the efficient construction of matrices; each datapackage can have data for multiple matrices, and we can then create filtered datapackages which exclusively have data for the matrix of interest. As such, they should be considered read-only, though this is not enforced."""
+        This method was introduced to allow for the efficient construction of matrices; each datapackage can have data for multiple matrices, and we can then create filtered datapackages which exclusively have data for the matrix of interest. As such, they should be considered read-only, though this is not enforced.
+        """
         fdp = FilteredDatapackage()
         fdp.fs = self.fs
         fdp.metadata = {k: v for k, v in self.metadata.items() if k != "resources"}
@@ -369,7 +371,7 @@ class Datapackage(DatapackageBase):
             "id": id_ or uuid.uuid4().hex,
             "licenses": (metadata or {}).get("licenses", DEFAULT_LICENSES),
             "resources": [],
-            "created": datetime.datetime.utcnow().isoformat("T") + "Z",
+            "created": utc_now().isoformat("T") + "Z",
             "combinatorial": combinatorial,
             "sequential": sequential,
             "seed": seed,
@@ -1053,17 +1055,16 @@ def create_datapackage(
     Licenses are specified as a list in ``metadata``. The default license is the `Open Data Commons Public Domain Dedication and License v1.0 <http://opendatacommons.org/licenses/pddl/>`__.
 
     Args:
-
-        * fs: A `Filesystem`, optional. A new `MemoryFS` is used if not provided.
-        * name: `str`, optional. A new uuid is used if not provided.
-        * id_. `str`, optional. A new uuid is used if not provided.
-        * metadata. `dict`, optional. Metadata dictionary following datapackage specification; see above.
-        * combinatorial. `bool`, default `False.: Policy on how to sample columns across multiple data arrays; see readme.
-        * sequential. `bool`, default `False.: Policy on how to sample columns in data arrays; see readme.
-        * seed. `int`, optional. Seed to use in random number generator.
-        * sum_intra_duplicates. `bool`, default `True`. Should duplicate elements in a single data resource be summed together, or should the last value replace previous values.
-        * sum_inter_duplicates. `bool`, default `False`. Should duplicate elements in across data resources be summed together, or should the last value replace previous values. Order of data resources is given by the order they are added to the data package.
-        * matrix_serialize_format_type. `MatrixSerializeFormat`, default `MatrixSerializeFormat.NUMPY`. Matrix serialization format type.
+        * fs: A ``Filesystem``, optional. A new ``MemoryFS`` is used if not provided.
+        * name: ``str``, optional. A new uuid is used if not provided.
+        * `id_`: ``str``, optional. A new uuid is used if not provided.
+        * metadata: ``dict``, optional. Metadata dictionary following datapackage specification; see above.
+        * combinatorial: ``bool``, default ``False`` .: Policy on how to sample columns across multiple data arrays; see readme.
+        * sequential: ``bool``, default ``False`` .: Policy on how to sample columns in data arrays; see readme.
+        * seed: ``int``, optional. Seed to use in random number generator.
+        * sum_intra_duplicates: ``bool``, default ``True``. Should duplicate elements in a single data resource be summed together, or should the last value replace previous values.
+        * sum_inter_duplicates: ``bool``, default ``False``. Should duplicate elements in across data resources be summed together, or should the last value replace previous values. Order of data resources is given by the order they are added to the data package.
+        * matrix_serialize_format_type: ``MatrixSerializeFormat``, default ``MatrixSerializeFormat.NUMPY``. Matrix serialization format type.
 
     Returns:
 
@@ -1099,9 +1100,9 @@ def load_datapackage(
 
     Args:
 
-        * fs_or_obj. A `Filesystem` or an instance of `DatapackageBase`.
-        * mmap_mode. `str`, optional. Define memory mapping mode to use when loading Numpy arrays.
-        * proxy. bool, default `False`. Load proxies instead of complete Numpy arrays; see above.
+        * fs_or_obj: A `Filesystem` or an instance of `DatapackageBase`.
+        * mmap_mode: `str`, optional. Define memory mapping mode to use when loading Numpy arrays.
+        * proxy: bool, default `False`. Load proxies instead of complete Numpy arrays; see above.
 
     Returns:
 
@@ -1116,22 +1117,29 @@ def load_datapackage(
     return obj
 
 
-def simple_graph(data: dict, fs: Optional[FS] = None, **metadata):
+def simple_graph(data: dict, fs: Optional[FS] = None, **metadata) -> Datapackage:
     """Easy creation of simple datapackages with only persistent vectors.
 
-    ``data`` is a dictionary with the form:
+    Args:
+        * data: is a dictionary.
+            The data dictionary has the form::
+
+                {
+                    matrix_name: [
+                    (row_id, col_id, value, flip)
+                    ]
+                }
 
-    ..code-block:: python
 
-        matrix_name (str): [
-            (row id (int), col id (int), value (float), flip (bool, default False))
-        ]
+            Where `row_id` and `col_id are an `int` s, value is a `float` and flip is a `bool`  (False by default).
 
-    ``fs`` is a filesystem.
+        * fs: is a filesystem.
+        * metadata: are passed as kwargs to ``create_datapackage()``.
 
-    ``metadata`` are passed as kwargs to ``create_datapackage()``.
+    Returns:
+        the datapackage.
 
-    Returns the datapackage."""
+    """
     dp = create_datapackage(fs=fs, **metadata)
     for key, value in data.items():
         indices_array = np.array([row[:2] for row in value], dtype=INDICES_DTYPE)

{bw-processing-0.9 → bw_processing-0.9.2}/bw_processing/errors.py

@@ -29,7 +29,8 @@ class ShapeMismatch(BrightwayProcessingError):
 class InvalidName(BrightwayProcessingError):
     """Name fails datapackage requirements:
 
-    A short url-usable (and preferably human-readable) name of the package. This MUST be lower-case and contain only alphanumeric characters along with ".", "_" or "-" characters."""
+    A short url-usable (and preferably human-readable) name of the package. This MUST be lower-case and contain only alphanumeric characters along with ".", "_" or "-" characters.
+    """
 
     pass
 

{bw-processing-0.9 → bw_processing-0.9.2}/bw_processing/filesystem.py

@@ -23,7 +23,8 @@ def safe_filename(
 
     if `add_hash`, appends hash of `string` to avoid name collisions.
 
-    From http://stackoverflow.com/questions/295135/turn-a-string-into-a-valid-filename-in-python"""
+    From http://stackoverflow.com/questions/295135/turn-a-string-into-a-valid-filename-in-python
+    """
     safe = re.sub(
         r"[-\s]+",
         "-",

{bw-processing-0.9 → bw_processing-0.9.2}/bw_processing/io_helpers.py

@@ -12,8 +12,10 @@ from fs.zipfs import ZipFS
 from .constants import MatrixSerializeFormat
 from .errors import InvalidMimetype
 from .proxies import Proxy
+
 try:
     from .io_parquet_helpers import load_ndarray_from_parquet, save_arr_to_parquet
+
     PARQUET = True
 except ImportError:
     load_ndarray_from_parquet = None

{bw-processing-0.9 → bw_processing-0.9.2}/bw_processing/merging.py

@@ -30,7 +30,7 @@ def update_nrows(resource: dict, data: Any) -> dict:
 def add_resource_suffix(metadata: dict, suffix: str) -> dict:
     """Update the ``name``, ``path``, and ``group`` values to include ``suffix``. The suffix comes after the basename but after the data type suffix (e.g. indices, data).
 
-    Given the suffix _foo" and the metadata:
+    Given the suffix ``_foo`` and the metadata::
 
         {
             "name": "sa-data-vector-from-dict.indices",
@@ -38,7 +38,7 @@ def add_resource_suffix(metadata: dict, suffix: str) -> dict:
             "group": "sa-data-vector-from-dict",
         }
 
-    Returns:
+    It will return::
 
         {
             "name": "sa-data-vector-from-dict_foo.indices",

{bw-processing-0.9 → bw_processing-0.9.2}/bw_processing/proxies.py

@@ -13,6 +13,7 @@ class Proxy:
     def __call__(self):
         """Retrieve the data.
 
-        Rewinds the file or buffer to 0, see https://github.com/brightway-lca/bw_processing/issues/9."""
+        Rewinds the file or buffer to 0, see https://github.com/brightway-lca/bw_processing/issues/9.
+        """
         self.kwargs[self.label].seek(0)
         return self.func(**self.kwargs)

{bw-processing-0.9 → bw_processing-0.9.2}/bw_processing/unique_fields.py

@@ -8,7 +8,7 @@ def greedy_set_cover(data, exclude=None, raise_error=True):
 
     Feature selection is a well known problem, and is analogous to the `set cover problem <https://en.wikipedia.org/wiki/Set_cover_problem>`__, for which there is a `well known heuristic <https://en.wikipedia.org/wiki/Set_cover_problem#Greedy_algorithm>`__.
 
-    Example:
+    Example::
 
         data = [
             {'a': 1, 'b': 2, 'c': 3},
@@ -73,7 +73,7 @@ def as_unique_attributes(data, exclude=None, include=None, raise_error=False):
 
     Each element in ``data`` must have the attribute ``id``, and it must be unique. However, the field "id" is not used in selecting the unique set of attributes.
 
-    If no set of attributes is found that uniquely identifies all features is found, all fields are used. To have this case raise an error, pass ``raise_error=True``.
+    If no set of attributes is found that uniquely identifies all features is found, all fields are used. To have this case raise an error, pass ``raise_error=True``.::
 
         data = [
             {},
@@ -89,6 +89,7 @@ def as_unique_attributes(data, exclude=None, include=None, raise_error=False):
 
     Raises:
         InconsistentFields: Not all features provides all fields.
+
     """
     include = set(include or [])
     fields = greedy_set_cover(data, exclude=exclude, raise_error=raise_error)

{bw-processing-0.9 → bw_processing-0.9.2}/bw_processing/utils.py

@@ -1,3 +1,4 @@
+from datetime import datetime
 from io import BytesIO
 from pathlib import Path
 from typing import Any, Union
@@ -98,3 +99,11 @@ def resolve_dict_iterator(iterator: Any, nrows: int = None) -> tuple:
         ),
         array["flip"],
     )
+
+
+def utc_now() -> datetime:
+    """Get current datetime compatible with Py 3.8 to 3.12"""
+    if hasattr(datetime, "UTC"):
+        return datetime.now(datetime.UTC)
+    else:
+        return datetime.utcnow()

{bw-processing-0.9 → bw_processing-0.9.2/bw_processing.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: bw-processing
-Version: 0.9
+Version: 0.9.2
 Summary: Tools to create structured arrays in a common format
 Home-page: https://github.com/brightway-lca/bw_processing
 Author: Chris Mutel
@@ -46,10 +46,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]
@@ -57,7 +57,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

bw_processing-0.9.2/docs/conf.py

@@ -0,0 +1,109 @@
+### import setup ##################################################################################
+
+import datetime
+
+### project information ###########################################################################
+
+project = "Brightway Processing"
+author = "Brightway Developers"
+copyright = datetime.date.today().strftime("%Y") + ' Brightway Developers'
+
+### project configuration #########################################################################
+
+extensions = [
+    # native extensions
+    'sphinx.ext.autodoc',
+    'sphinx.ext.autosummary',
+    'sphinx.ext.mathjax',
+    'sphinx.ext.viewcode',
+    'sphinx.ext.intersphinx',
+    'sphinx.ext.extlinks',
+    'sphinx.ext.napoleon',
+    # theme
+    'sphinx_rtd_theme',
+    # Markdown support
+    'myst_parser',
+    # API documentation support
+    'autoapi',
+    # responsive web component support
+    'sphinx_design',
+    # copy button on code blocks
+    "sphinx_copybutton",
+]
+
+exclude_patterns = ['_build']
+
+# The master toctree document.
+master_doc = 'index'
+
+### theme configuration ############################################################################
+
+html_theme = "sphinx_rtd_theme"
+html_title = "Brightway Processing"
+html_show_sphinx = False
+
+html_theme_options = {
+    'logo_only': False,
+    'display_version': True,
+    'prev_next_buttons_location': 'bottom',
+    # Toc options
+    'collapse_navigation': True,
+    'sticky_navigation': True,
+    'navigation_depth': 4,
+    'includehidden': True,
+    'titles_only': True
+}
+
+html_logo = 'https://raw.githubusercontent.com/brightway-lca/brightway-documentation/main/source/_static/logo/BW_all_white_transparent_landscape_wide.svg'
+html_favicon = 'https://github.com/brightway-lca/brightway-documentation/blob/main/source/_static/logo/BW_favicon_500x500.png'
+
+### extension configuration ########################################################################
+
+## myst_parser configuration ############################################
+## https://myst-parser.readthedocs.io/en/latest/configuration.html
+
+source_suffix = {
+    '.rst': 'restructuredtext',
+    '.md': 'markdown',
+}
+
+myst_enable_extensions = [
+    "amsmath",
+    "colon_fence",
+    "deflist",
+    "dollarmath",
+    "html_image",
+]
+
+## autoapi configuration ################################################
+## https://sphinx-autoapi.readthedocs.io/en/latest/reference/config.html#customisation-options
+
+autoapi_options = [
+    'members',
+    'undoc-members',
+    'private-members',
+    'show-inheritance',
+    'show-module-summary',
+]
+
+autoapi_python_class_content = 'both'
+autoapi_member_order = 'groupwise'
+autoapi_root = 'content/api'
+autoapi_keep_files = False
+
+autoapi_dirs = [
+    '../bw_processing',
+]
+
+autoapi_ignore = [
+    '*/data/*',
+    '*tests/*',
+    '*tests.py',
+    '*validation.py',
+    '*version.py',
+    '*.rst',
+    '*.yml',
+    '*.md',
+    '*.json',
+    '*.data'
+]

bw-processing-0.9/docs/conf.py

@@ -1,48 +0,0 @@
-"""Sphinx configuration."""
-import importlib.metadata
-import os
-import shutil
-
-from sphinx.ext import apidoc
-
-# Run sphinx-apidoc
-# This hack is necessary since RTD does not issue `sphinx-apidoc` before running
-# `sphinx-build -b html . _build/html`. See Issue:
-# https://github.com/readthedocs/readthedocs.org/issues/1139
-
-
-__location__ = os.path.dirname(__file__)
-
-output_dir = os.path.join(__location__, "api")
-module_dir = os.path.join(__location__, "../bw_processing")
-try:
-    shutil.rmtree(output_dir)
-except FileNotFoundError:
-    pass
-
-try:
-    args = f"--implicit-namespaces -f -o {output_dir} {module_dir}".split(" ")
-    apidoc.main(args)
-except Exception as e:
-    print("Running `sphinx-apidoc` failed!\n{}".format(e))
-
-# General Configuration
-
-project = "bw-processing"
-author = "Chris Mutel"
-copyright = "2023, Chris Mutel"
-extensions = [
-    "sphinx.ext.autodoc",
-    "sphinx.ext.napoleon",
-    "myst_parser",
-]
-source_suffix = {
-        ".rst": "restructuredtext",
-        ".md": "markdown",
-        }
-autodoc_typehints = "description"
-html_theme = "furo"
-
-needs_sphinx = "5.0"
-
-version = importlib.metadata.version("bw_processing")