Merge pull request #182 from AllSpiceIO/gp/design-reuse

[ID-707] First pass of BOM generation including Device Sheets for Altium projects.

CHANGELOG.md

@@ -1,5 +1,25 @@
 # Changelog
 
+## v3.6.0
+
+### What's Changed
+
+## What's Changed
+
+- Generate BOMs with Device Sheets and Board Level Annotations on Altium
+  Projects by @shrik450 and @polypour in
+  https://github.com/AllSpiceIO/py-allspice/pull/182 and
+  https://github.com/AllSpiceIO/py-allspice/pull/183/
+
+  Adds support for Altium Device Sheets and Board Level Annotations in
+  `list_components` and `generate_bom`. To use device sheets located in another
+  repo, pass the `design_reuse_repositories` argument to those functions.
+
+- Update syrupy requirement from ~=4.6 to ~=4.7 by @dependabot in https://github.com/AllSpiceIO/py-allspice/pull/179
+- Add method to download an attachment by @shrik450 in https://github.com/AllSpiceIO/py-allspice/pull/181
+- Include pin information in components by @shrik450 in https://github.com/AllSpiceIO/py-allspice/pull/180
+- Update pdoc requirement from ~=14.5 to ~=14.7 by @dependabot in https://github.com/AllSpiceIO/py-allspice/pull/185
+
 ## v3.5.0
 
 ### What's Changed

allspice/__init__.py

@@ -23,7 +23,7 @@
 )
 from .exceptions import AlreadyExistsException, NotFoundException
 
-__version__ = "3.5.0"
+__version__ = "3.6.0"
 
 __all__ = [
     "AllSpice",

allspice/utils/bom_generation.py

@@ -5,7 +5,7 @@
 import re
 from dataclasses import dataclass
 from enum import Enum
-from typing import Iterable, Optional, Union
+from typing import Iterable, Mapping, Optional, Union
 
 from ..allspice import AllSpice
 from ..apiobject import Ref, Repository
@@ -94,7 +94,7 @@ class SortOrder(Enum):
     """
 
 
-ColumnsMapping = dict[str, ColumnConfig | list[str] | str]
+ColumnsMapping = Mapping[str, ColumnConfig | list[str] | str]
 """
 Configuration for the columns in the BOM. See `ColumnConfig` for a detailed
 description of the configuration for each column. The keys in this dictionary
@@ -116,6 +116,7 @@ def generate_bom(
     variant: Optional[str] = None,
     ref: Ref = "main",
     remove_non_bom_components: bool = True,
+    design_reuse_repos: list[Repository] = [],
 ) -> Bom:
     """
     Generate a BOM for a project.
@@ -173,6 +174,7 @@ def generate_bom(
         variant,
         ref,
         combine_multi_part=True,
+        design_reuse_repos=design_reuse_repos,
     )
 
     if remove_non_bom_components:
@@ -207,6 +209,7 @@ def generate_bom_for_altium(
     variant: Optional[str] = None,
     ref: Ref = "main",
     remove_non_bom_components: bool = True,
+    design_reuse_repos: list[Repository] = [],
 ) -> Bom:
     """
     Generate a BOM for an Altium project.
@@ -246,6 +249,7 @@ def generate_bom_for_altium(
         variant,
         ref,
         remove_non_bom_components,
+        design_reuse_repos=design_reuse_repos,
     )