Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Part: Add PartIdentifier (mfr, p/n, datasheet) #172

Merged
merged 3 commits into from
May 29, 2024

Conversation

JasperZP
Copy link
Contributor

@JasperZP JasperZP commented May 29, 2024

Part: Add PartIdentifier (mfr, p/n, datasheet)

Description

Adds an optional PartIdentifier to a Part, which describes the partnumber, manufacturer, and datasheet.
This could be used for BOM exports.

Fixes #165

Checklist

Please read and execute the following:

  • My code follows the coding guidelines of this project
  • My PR title is following the contribution guidelines
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation (if applicable)
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works (if applicable)
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules
  • I ran Black to format my code

Code of Conduct

By submitting this issue, you agree to follow our Code of Conduct:

Adds an optional PartIdentifier to a Part, which describes the
partnumber, manufacturer, and datasheet.
This could be used for BOM exports.

Fixes faebryk#165
Copy link
Contributor

@IoannisP-ITENG IoannisP-ITENG left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice idea to be able to pass through info from the pickeroption to the module descriptive_properties!
There is already (nearly) a way to do that with lower footprint.
You can use the info dict in pickeroption and pass that instead of the part because it contains the part anyway. This is useful for future additions too to avoid breaking the supplier API. The supplier can that just transparently decide to ad the properties to the module.
See the comments for more detail.

src/faebryk/libs/picker/lcsc.py Outdated Show resolved Hide resolved
src/faebryk/libs/picker/picker.py Outdated Show resolved Hide resolved
src/faebryk/libs/picker/picker.py Outdated Show resolved Hide resolved
src/faebryk/libs/picker/picker.py Outdated Show resolved Hide resolved
src/faebryk/libs/picker/lcsc.py Outdated Show resolved Hide resolved
src/faebryk/libs/picker/lcsc.py Outdated Show resolved Hide resolved
src/faebryk/libs/picker/picker.py Outdated Show resolved Hide resolved
Remove PartIdentifier and merge functionality into Part.info.
Add DescriptiveProperties for standardizing the mfr, datasheet, and p/n string names.
Sets PickerOption.info to accept DescriptiveProperties explicitly
@IoannisP-ITENG IoannisP-ITENG merged commit 7b43f2b into faebryk:main May 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Components should have a Manufacturer and Partnumber field, for BOM and KiCad
2 participants