brightpath 0.0.3__tar.gz → 0.0.4__tar.gz

{brightpath-0.0.3/brightpath.egg-info → brightpath-0.0.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: brightpath
-Version: 0.0.3
+Version: 0.0.4
 Summary: Convert Brightway2 LCI data to Simapro and back.
 Author-email: Romain Sacchi <romain.sacchi@psi.ch>
 License: BSD 3-Clause License
@@ -53,6 +53,7 @@ License-File: LICENSE
 Requires-Dist: bw2io
 Requires-Dist: prettytable>=3
 Requires-Dist: PyYAML>=6
+Requires-Dist: XlsxWriter>=3
 Provides-Extra: test
 Requires-Dist: pytest; extra == "test"
 Requires-Dist: pytest-cov; extra == "test"
@@ -136,6 +137,17 @@ converter.convert_to_brightway()
 # converter.i.write_database()
 ```
 
+You can also write a Brightway Excel workbook directly, without first creating
+a Brightway database:
+
+```python
+path = converter.convert_to_brightway(
+    format="excel",
+    filename="lci-my-simapro-import.xlsx",
+)
+print(path)
+```
+
 ## Development
 
 * Source code is formatted with standard Python tools and tested with
@@ -148,4 +160,3 @@ converter.convert_to_brightway()
 
 BrightPath is distributed under the
 [BSD-3-Clause license](LICENSE).
-

{brightpath-0.0.3 → brightpath-0.0.4}/README.md

@@ -68,6 +68,17 @@ converter.convert_to_brightway()
 # converter.i.write_database()
 ```
 
+You can also write a Brightway Excel workbook directly, without first creating
+a Brightway database:
+
+```python
+path = converter.convert_to_brightway(
+    format="excel",
+    filename="lci-my-simapro-import.xlsx",
+)
+print(path)
+```
+
 ## Development
 
 * Source code is formatted with standard Python tools and tested with
@@ -80,4 +91,3 @@ converter.convert_to_brightway()
 
 BrightPath is distributed under the
 [BSD-3-Clause license](LICENSE).
-

{brightpath-0.0.3 → brightpath-0.0.4}/brightpath/__init__.py

@@ -1,5 +1,5 @@
 __all__ = ("BrightwayConverter", "SimaproConverter", "DATA_DIR")
-__version__ = (0, 0, 3)
+__version__ = (0, 0, 4)
 
 from pathlib import Path
 

{brightpath-0.0.3 → brightpath-0.0.4}/brightpath/simaproconverter.py

@@ -5,12 +5,14 @@ Simapro inventories to Brightway inventory files.
 
 import csv
 import logging
+import numbers
 import re
 import tempfile
 from copy import deepcopy
 from pathlib import Path
 
 import bw2io
+import xlsxwriter
 
 from . import DATA_DIR
 from .utils import (
@@ -30,6 +32,44 @@ from .utils import (
 WASTE_TERMS = get_waste_exchange_names()
 logger = logging.getLogger(__name__)
 
+EXCEL_ACTIVITY_SKIP_FIELDS = {
+    "database",
+    "exchanges",
+    "name",
+    "parameters",
+    "simapro metadata",
+}
+EXCEL_EXCHANGE_SKIP_FIELDS = {"input", "output"}
+EXCEL_ACTIVITY_FIELD_ORDER = [
+    "reference product",
+    "unit",
+    "location",
+    "code",
+    "comment",
+    "type",
+    "categories",
+]
+EXCEL_EXCHANGE_FIELD_ORDER = [
+    "name",
+    "amount",
+    "database",
+    "reference product",
+    "product",
+    "location",
+    "unit",
+    "categories",
+    "type",
+    "formula",
+    "uncertainty type",
+    "loc",
+    "scale",
+    "shape",
+    "minimum",
+    "maximum",
+    "simapro name",
+    "comment",
+]
+
 
 def _version_tuple(version: str) -> tuple:
     try:
@@ -209,6 +249,57 @@ def is_simapro_final_waste_flow(exchange: dict) -> bool:
     )
 
 
+def _safe_excel_filename(name: str) -> str:
+    safe_name = re.sub(r"[^A-Za-z0-9_.-]+", "_", name).strip("_")
+    return safe_name or "brightway-inventory"
+
+
+def _valid_worksheet_name(name: str) -> str:
+    cleaned = name
+    for char in {"\\", "/", "*", "[", "]", ":", "?"}:
+        cleaned = cleaned.replace(char, "#")
+    if cleaned == "History":
+        cleaned = "History-worksheet"
+    return (cleaned or "Inventory")[:30]
+
+
+def _is_excel_exportable(value) -> bool:
+    if value is None:
+        return True
+    if isinstance(value, (str, bool, numbers.Number)):
+        return True
+    if isinstance(value, (tuple, list)):
+        return all(_is_excel_exportable(item) for item in value)
+    return False
+
+
+def _format_excel_value(value):
+    if isinstance(value, (tuple, list)):
+        return "::".join("" if item is None else str(_format_excel_value(item)) for item in value)
+    return value
+
+
+def _ordered_export_fields(data: list[dict], preferred: list[str], skipped: set[str]) -> list[str]:
+    fields = {
+        field for row in data for field, value in row.items() if field not in skipped and _is_excel_exportable(value)
+    }
+    ordered = [field for field in preferred if field in fields]
+    ordered.extend(sorted(fields.difference(ordered)))
+    return ordered
+
+
+def _write_excel_cell(sheet, row: int, column: int, value, cell_format=None) -> None:
+    value = _format_excel_value(value)
+    if value is None:
+        return
+    if isinstance(value, bool):
+        sheet.write_boolean(row, column, value, cell_format)
+    elif isinstance(value, numbers.Number):
+        sheet.write_number(row, column, value, cell_format)
+    else:
+        sheet.write_string(row, column, str(value), cell_format)
+
+
 def load_ecoinvent_activities(version: str) -> list:
     if not re.fullmatch(r"\d+(?:\.\d+){1,2}", version):
         raise ValueError(f"Unsupported ecoinvent version format: {version!r}.")
@@ -396,7 +487,9 @@ class SimaproConverter:
                         if exc["input"][0] is None:
                             exc["input"] = (self.i.db_name, exc["input"][1])
 
-    def convert_to_brightway(self):
+    def convert_to_brightway(self, format: str = "data", filename=None):
+        if format not in ("data", "excel"):
+            raise ValueError("Format must be either `data` or `excel`.")
 
         logger.info("Formatting exchanges.")
         for ds in self.i.data:
@@ -473,6 +566,74 @@ class SimaproConverter:
         self.check_inventories()
         logger.info("SimaPro conversion completed.")
 
+        if format == "excel":
+            return self.write_brightway_excel(filename)
+
+        return self.i.data
+
+    def write_brightway_excel(self, filename=None) -> Path:
+        filepath = self._excel_filepath(filename)
+        filepath.parent.mkdir(parents=True, exist_ok=True)
+
+        workbook = xlsxwriter.Workbook(filepath)
+        bold = workbook.add_format({"bold": True})
+        bold.set_font_size(12)
+        sheet = workbook.add_worksheet(_valid_worksheet_name(self.db_name))
+
+        row = 0
+        row = self._write_database_excel_section(sheet, row, bold)
+        row += 1
+
+        for activity in self.i.data:
+            row = self._write_activity_excel_section(sheet, row, activity, bold)
+            row += 1
+
+        workbook.close()
+        return filepath
+
+    def _excel_filepath(self, filename=None) -> Path:
+        if filename is None:
+            return Path.cwd() / f"lci-{_safe_excel_filename(self.db_name)}.xlsx"
+
+        filepath = Path(filename).expanduser()
+        if filepath.suffix == "":
+            filepath = filepath.with_suffix(".xlsx")
+        if filepath.suffix.lower() != ".xlsx":
+            raise ValueError("Brightway Excel exports must use a .xlsx filename.")
+        return filepath.resolve()
+
+    def _write_database_excel_section(self, sheet, row: int, bold) -> int:
+        _write_excel_cell(sheet, row, 0, "Database", bold)
+        _write_excel_cell(sheet, row, 1, self.db_name)
+        return row + 1
+
+    def _write_activity_excel_section(self, sheet, row: int, activity: dict, bold) -> int:
+        _write_excel_cell(sheet, row, 0, "Activity", bold)
+        _write_excel_cell(sheet, row, 1, activity["name"])
+        row += 1
+
+        for field in _ordered_export_fields([activity], EXCEL_ACTIVITY_FIELD_ORDER, EXCEL_ACTIVITY_SKIP_FIELDS):
+            _write_excel_cell(sheet, row, 0, field)
+            _write_excel_cell(sheet, row, 1, activity.get(field))
+            row += 1
+
+        exchanges = activity.get("exchanges", [])
+        _write_excel_cell(sheet, row, 0, "Exchanges", bold)
+        row += 1
+
+        if exchanges:
+            columns = _ordered_export_fields(exchanges, EXCEL_EXCHANGE_FIELD_ORDER, EXCEL_EXCHANGE_SKIP_FIELDS)
+            for column, field in enumerate(columns):
+                _write_excel_cell(sheet, row, column, field)
+            row += 1
+
+            for exchange in exchanges:
+                for column, field in enumerate(columns):
+                    _write_excel_cell(sheet, row, column, exchange.get(field))
+                row += 1
+
+        return row
+
     def remove_empty_datasets(self):
         self.i.data = [ds for ds in self.i.data if len(ds["exchanges"]) >= 1]
 

{brightpath-0.0.3 → brightpath-0.0.4/brightpath.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: brightpath
-Version: 0.0.3
+Version: 0.0.4
 Summary: Convert Brightway2 LCI data to Simapro and back.
 Author-email: Romain Sacchi <romain.sacchi@psi.ch>
 License: BSD 3-Clause License
@@ -53,6 +53,7 @@ License-File: LICENSE
 Requires-Dist: bw2io
 Requires-Dist: prettytable>=3
 Requires-Dist: PyYAML>=6
+Requires-Dist: XlsxWriter>=3
 Provides-Extra: test
 Requires-Dist: pytest; extra == "test"
 Requires-Dist: pytest-cov; extra == "test"
@@ -136,6 +137,17 @@ converter.convert_to_brightway()
 # converter.i.write_database()
 ```
 
+You can also write a Brightway Excel workbook directly, without first creating
+a Brightway database:
+
+```python
+path = converter.convert_to_brightway(
+    format="excel",
+    filename="lci-my-simapro-import.xlsx",
+)
+print(path)
+```
+
 ## Development
 
 * Source code is formatted with standard Python tools and tested with
@@ -148,4 +160,3 @@ converter.convert_to_brightway()
 
 BrightPath is distributed under the
 [BSD-3-Clause license](LICENSE).
-

{brightpath-0.0.3 → brightpath-0.0.4}/brightpath.egg-info/requires.txt

@@ -1,6 +1,7 @@
 bw2io
 prettytable>=3
 PyYAML>=6
+XlsxWriter>=3
 
 [dev]
 bandit

{brightpath-0.0.3 → brightpath-0.0.4}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "brightpath"
-version = "0.0.3"
+version = "0.0.4"
 description = "Convert Brightway2 LCI data to Simapro and back."
 dynamic = ["dependencies"]
 authors = [

{brightpath-0.0.3 → brightpath-0.0.4}/requirements.txt

@@ -1,3 +1,4 @@
 bw2io
 prettytable>=3
 PyYAML>=6
+XlsxWriter>=3

{brightpath-0.0.3 → brightpath-0.0.4}/tests/test_simaproconverter.py

@@ -1,5 +1,6 @@
 from types import SimpleNamespace
 
+import bw2io
 import pytest
 
 from brightpath import simaproconverter
@@ -338,6 +339,69 @@ def test_convert_to_brightway_formats_dataset_and_exchanges():
     assert biosphere["categories"] == ("natural resource", "in water")
 
 
+def test_convert_to_brightway_rejects_unknown_output_format():
+    converter = make_converter([])
+
+    with pytest.raises(ValueError, match="Format must be"):
+        converter.convert_to_brightway(format="json")
+
+
+def test_convert_to_brightway_writes_excel_importable_by_bw2io(tmp_path):
+    data = [
+        {
+            "name": "Electricity {CH}| market for | Cut-off, U",
+            "unit": "kilowatt hour",
+            "simapro metadata": {"Comment": "dataset comment"},
+            "exchanges": [
+                {
+                    "type": "production",
+                    "name": "Electricity {CH}| market for | Cut-off, U",
+                    "unit": "kilowatt hour",
+                    "amount": 1.0,
+                    "input": (None, "production"),
+                },
+                {
+                    "type": "biosphere",
+                    "name": "Water, lake",
+                    "categories": ("natural resource", "unspecified"),
+                    "unit": "cubic meter",
+                    "amount": 4.0,
+                },
+            ],
+        }
+    ]
+    converter = make_converter(data, db_name="converted_db")
+
+    output = converter.convert_to_brightway(format="excel", filename=tmp_path / "converted")
+
+    assert output == (tmp_path / "converted.xlsx").resolve()
+    importer = bw2io.ExcelImporter(output)
+    assert importer.db_name == "converted_db"
+    assert len(importer.data) == 1
+
+    dataset = importer.data[0]
+    assert dataset["name"] == "market for electricity"
+    assert dataset["reference product"] == "electricity"
+    assert dataset["location"] == "CH"
+    assert dataset["unit"] == "kilowatt hour"
+    assert dataset["comment"] == "dataset comment"
+
+    production = next(exc for exc in dataset["exchanges"] if exc["type"] == "production")
+    biosphere = next(exc for exc in dataset["exchanges"] if exc["type"] == "biosphere")
+    assert production["name"] == "market for electricity"
+    assert production["reference product"] == "electricity"
+    assert production["amount"] == 1
+    assert biosphere["name"] == "Water, lake"
+    assert biosphere["categories"] == "natural resource::in water"
+
+
+def test_write_brightway_excel_requires_xlsx_suffix(tmp_path):
+    converter = make_converter([])
+
+    with pytest.raises(ValueError, match="\\.xlsx"):
+        converter.write_brightway_excel(tmp_path / "converted.csv")
+
+
 def test_convert_to_brightway_drops_simapro_final_waste_indicators():
     data = [
         {