Merge pull request #27 from BuildingSync/task/uv-python-3.14

Modernization updates

Author: axelstudios

.github/workflows/ci.yml

@@ -9,34 +9,19 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        os: [ubuntu-latest]
-        python-version: ["3.9", "3.13"]
+        python-version: ["3.10", "3.11", "3.12", "3.13", "3.14"]
+        os: [ubuntu-latest, macos-latest, windows-latest]
     runs-on: ${{ matrix.os }}
     steps:
-      - uses: actions/checkout@v4
-      - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v5
+      - uses: actions/checkout@v6
+      - name: Install uv and set the Python version
+        uses: astral-sh/setup-uv@v7
         with:
           python-version: ${{ matrix.python-version }}
-      - name: Install poetry
-        uses: abatilo/actions-poetry@v3
-        with:
-          poetry-version: 1.8.4
-      - name: Install dependencies with Poetry
-        run: |
-          pip install --upgrade pip
-          poetry install
+          version: "0.9.27"
+      - name: Install the project
+        run: uv sync --locked
       - name: Run pytest
-        run: |
-          poetry run pytest
-  pre-commit:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-python@v5
-        with:
-          python-version: "3.13"
+        run: uv run pytest -v
       - name: Run pre-commit
-        uses: pre-commit/action@v3.0.1
-        with:
-          extra_args: --all-files
+        run: uv run pre-commit run -a

.github/workflows/pypi_release.yml

@@ -0,0 +1,48 @@
+name: PyPIRelease
+# https://packaging.python.org/en/latest/guides/publishing-package-distribution-releases-using-github-actions-ci-cd-workflows/
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  build:
+    name: Build distribution 📦
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v6
+        with:
+          persist-credentials: false
+      - name: Install uv
+        uses: astral-sh/setup-uv@v7
+        with:
+          version: "0.9.27"
+      - name: Build a binary wheel and a source tarball
+        run: uv build
+      - name: Store the distribution packages
+        uses: actions/upload-artifact@v6
+        with:
+          name: python-package-distributions
+          path: dist/
+
+  publish-to-pypi:
+    name: >-
+      Publish Python 🐍 distribution 📦 to PyPI
+    needs:
+      - build
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi_release
+      url: https://pypi.org/p/buildingid/
+    permissions:
+      id-token: write # IMPORTANT: mandatory for trusted publishing
+
+    steps:
+      - name: Download all the dists
+        uses: actions/download-artifact@v7
+        with:
+          name: python-package-distributions
+          path: dist/
+      - name: Publish distribution 📦 to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

.pre-commit-config.yaml

@@ -1,6 +1,6 @@
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.6.0
+    rev: v6.0.0
     hooks:
       - id: trailing-whitespace
       - id: check-added-large-files
@@ -15,20 +15,27 @@ repos:
       - id: mixed-line-ending
       - id: pretty-format-json
         args: ["--autofix", "--no-sort-keys"]
+  - repo: https://github.com/asottile/pyupgrade
+    rev: v3.21.2
+    hooks:
+      - id: pyupgrade
   - repo: https://github.com/pre-commit/mirrors-prettier
     rev: v4.0.0-alpha.8
     hooks:
       - id: prettier
+        args: [--no-cache]
         types_or: [markdown, yaml]
   - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v1.12.1
+    rev: v1.19.1
     hooks:
       - id: mypy
+        additional_dependencies:
+          - pandas-stubs
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.7.0
+    rev: v0.14.14
     hooks:
       # Run the linter
-      - id: ruff
+      - id: ruff-check
         args: [--fix, --exit-non-zero-on-fix, --output-format=full]
       # Run the formatter
       - id: ruff-format

LICENSE

@@ -1,4 +1,4 @@
-BuildingSync®, Copyright (c) 2015, 2024 Alliance for Sustainable Energy, LLC, and other contributors.
+BuildingSync®, Copyright (c) 2015-2026 Alliance for Energy Innovation, LLC, and other contributors.
 
 All rights reserved.
 
@@ -17,7 +17,7 @@ respective party.
 
 (4) Other than as required in clauses (1) and (2), distributions in any form of modifications or other
 derivative works may not use the "BuildingSync" trademark or any other confusingly similar designation
-without specific prior written permission from Alliance for Sustainable Energy, LLC.
+without specific prior written permission from Alliance for Energy Innovation, LLC.
 
 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) AND ANY CONTRIBUTORS "AS IS" AND ANY EXPRESS OR
 IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND

README.md

@@ -12,18 +12,15 @@ pip install buildingsync-asset-extractor
 
 ### Install from source
 
-[Poetry](https://python-poetry.org/) is required to install buildingsync-asset-extractor.
+[uv](https://docs.astral.sh/uv/) is required to install buildingsync-asset-extractor.
 
 ```bash
 # Copy repo
-git clone https://github.com/BuildingSync/BuildingSync-asset-extractor.git
+git clone git@github.com:BuildingSync/BuildingSync-asset-extractor.git
 
 # install the package
 cd BuildingSync-asset-extractor
-poetry install
-
-# Test that it works, you should see a message describing the usage
-poetry run buildingsync_asset_extractor
+uv sync
 ```
 
 ## Usage
@@ -60,7 +57,7 @@ asset will be named the same as the original asset, with ' Units' appended at th
 To test usage:
 
 ```bash
-python buildingsync_asset_extractor/main.py
+uv run buildingsync_asset_extractor/main.py
 ```
 
 This will extract assets from `tests/files/testfile.xml` and save the results to `assets_output.json`
@@ -179,41 +176,36 @@ To enable pre-commit on every commit run the following from the command line fro
 BuildingSync-asset-extractor
 
 ```bash
-pre-commit install
+uv run pre-commit install
 ```
 
 To run pre-commit against the files without calling git commit, then run the following. This is useful when cleaning up
 the repo before committing.
 
 ```bash
-pre-commit run --all-files
+uv run pre-commit run --all-files
 ```
 
 ### Testing
 
-    poetry run pytest
+```bash
+uv run pytest -v
+```
 
 ## Releasing
 
 ```bash
-poetry build
+uv build
 
-# config and push to testpypi
-poetry config repositories.testpypi https://test.pypi.org/legacy/
-poetry publish -r testpypi
+# push to testpypi
+uv publish --publish-url https://test.pypi.org/legacy/
 
 # install from testpypi
 pip install --index-url https://test.pypi.org/simple/ buildingsync-asset-extractor
 ```
 
-If everything looks good, publish to pypi:
-
-```bash
-poetry publish
-```
-
-If you have environment variables setup for PYPI token username and password:
+If everything looks good, publish to PyPI:
 
 ```bash
-poetry publish --build --username $PYPI_USERNAME --password $PYPI_PASSWORD
+uv publish
 ```

buildingsync_asset_extractor/bae_types.py

@@ -1,10 +1,10 @@
 from dataclasses import dataclass
-from typing import Any, Optional
+from typing import Any
 
 
 @dataclass
 class Section:
-    type: Optional[str]
+    type: str | None
     areas: dict
 
 
@@ -27,13 +27,13 @@ class AssetDef:
     parent_path: str
     key: str
     export_units: bool
-    units: Optional[str] = None
+    units: str | None = None
 
 
 @dataclass
 class SystemData:
     value: Any
-    sqft: Optional[float] = None
-    cap: Optional[str] = None
-    cap_units: Optional[str] = None
-    units: Optional[str] = None
+    sqft: float | None = None
+    cap: str | None = None
+    cap_units: str | None = None
+    units: str | None = None

buildingsync_asset_extractor/converter.py

@@ -1,4 +1,4 @@
-from typing import Literal, Optional, get_args
+from typing import Literal, get_args
 
 from buildingsync_asset_extractor.bae_types import SystemData
 from buildingsync_asset_extractor.errors import BSyncProcessorError
@@ -22,7 +22,7 @@
 
 def unify_units(
     system_datas: list[SystemData],
-    to_units: Optional[str] = None,
+    to_units: str | None = None,
 ) -> list[SystemData]:
     if to_units is None:
         to_units = system_datas[0].cap_units

buildingsync_asset_extractor/cts/classes.py

@@ -1,8 +1,8 @@
 import functools
 import logging
+from collections.abc import Iterable
 from dataclasses import dataclass, field
 from pathlib import Path
-from typing import Iterable, Optional
 
 from lxml import etree as ETree  # noqa: N812
 
@@ -36,7 +36,7 @@ class FacilityAppearance:
     path: Path
 
     @functools.cached_property
-    def cheapest_package_of_measures_scenario(self) -> Optional[PackageOfMeasuresScenario]:
+    def cheapest_package_of_measures_scenario(self) -> PackageOfMeasuresScenario | None:
         # get the measures for reference
         measures_by_id = {m.get("ID"): Measure(m) for m in self.etree.findall("./Measures/Measure", self.etree.nsmap)}
 

buildingsync_asset_extractor/cts/cts.py

@@ -42,7 +42,7 @@ def aggregate_facilities(files: list[Path]) -> dict[str, Facility]:
 
     # for each file, get the facilities in the file
     for f in files:
-        file_etree = etree.parse(f)  # noqa: S320
+        file_etree = etree.parse(f)
         facility_etrees = file_etree.findall("/Facilities/Facility", namespaces=file_etree.getroot().nsmap)
 
         # for each facility in the file, add it to facility_by_id

buildingsync_asset_extractor/cts/parsers.py

@@ -88,8 +88,8 @@ def get_aggregated_findings_of_comprehensive_evaluations_estimated_life_cycle_da
 
 
 def get_potential_conservation_measures_per_technology_category(facility: Facility) -> pd.Series:
-    results = {k: 0 for k in ENERGY_AND_WATER_CONSERVATION_MEASURES}
-    results.update({k: 0 for k in technology_category_to_cts_field.values()})
+    results = dict.fromkeys(ENERGY_AND_WATER_CONSERVATION_MEASURES, 0)
+    results.update(dict.fromkeys(technology_category_to_cts_field.values(), 0))
 
     # for each measure
     measures = [