Kiutils

Overview

Non-breaking changes
- Added: Support for `bus_alias` tokens (PR 92)

All pull requests
* Tests: Added test case for zones on outer layers only by mvnmgrx in https://github.com/mvnmgrx/kiutils/pull/90
* Test: Basic bus_alias tests by mvnmgrx in https://github.com/mvnmgrx/kiutils/pull/94
* Adding support for bus_alias S-Expression. by hlprasu in https://github.com/mvnmgrx/kiutils/pull/92

New Contributors
* hlprasu made their first contribution in https://github.com/mvnmgrx/kiutils/pull/92

**Full Changelog**: https://github.com/mvnmgrx/kiutils/compare/v1.4.1...v1.4.2

Overview
Non-breaking changes
- Fixed: Zones on only outer layers produce wrong S-Expression for the `layer` token (PR 89)

All pull requests
* Fix: Zones on only outer layers produce wrong S-Expression for the `layer` token by JJendryka in https://github.com/mvnmgrx/kiutils/pull/89

New Contributors
* JJendryka made their first contribution in https://github.com/mvnmgrx/kiutils/pull/89

**Full Changelog**: https://github.com/mvnmgrx/kiutils/compare/v1.4.0...v1.4.1

Overview
This release adds initial KiCad v7 support.

Breaking changes
- Changed: Removed `SyFill` in favour of `Fill` tokens everywhere - (PR 76)

Non-breaking changes
- Added: Parsing new sheet names - (PR 59)
- Added: `Arc`, `Rectangle` and `Circle` tokens - (PR 76)
- Added: `Schematic.shapes` to hold arcs, rectangles and circles - (PR 76)
- Added: `GrTextBox`, `FpTextBox`, `SyTextBox` and `TextBox` tokens - (PR 76)
- Added: `SchematicSymbol.dnp` token - (PR 77)
- Added: `fields_autoplaced` token to all kinds of lables - (PR 77)
- Added: `NetclassFlag` token - (PR 80)
- Added: `Property.showName` token - (PR 80)
- Added: `Rule.severity` token for design rules - (PR 84)
- Added: `plotOnAllLayersSelection`, `dashedLineDashRatio` and `dashedLineGapRatio` tokens in `PlotSettings` - (PR 85)
- Added: `RenderCache` token for supported text items - (PR 87)
- Added: `ProjectInstance` tokens for schematic symbols and hierarchical sheets - (PR 88)
- Changed: Strokes are now parsed less strictly - (PR 57)
- Changed: Default value of `Stroke.type` from "dash" to "default" - (PR 63)
- Changed: `Stroke.color` is now optional - (PR 63)
- Changed: `Stroke.type` is now optional - (PR 82)
- Changed: `Schematic.uuid` is now optional - (PR 63)
- Changed: `Property.id` is now optional - (PR 78)
- Changed: `SymbolPin.nameEffects` and `SymbolPin.numberEffects` are now optional - (PR 82)
- Changed: `PlotSettings.svgUseInch` and `PlotSettings.excludeEdgeLayer` are now optional - (PR 85)
- Fixed: Regex parser not correctly handling backslashes in quoted strings - (PR 82)
- Fixed: `DesignRules.from_sexpr()` not parsing version token - (PR 84)

All pull requests
* kicad 7: fix changed property names by hvraven in https://github.com/mvnmgrx/kiutils/pull/59
* Kicad 7: parse strokes when not all elements are defined by hvraven in https://github.com/mvnmgrx/kiutils/pull/57
* Fix: Changes to KiCad v7 style Strokes + Tests + optional UUID tokens by mvnmgrx in https://github.com/mvnmgrx/kiutils/pull/63
* KiCad 7: Textboxes & Arcs, Rectangles and Circles in Schematic by mvnmgrx in https://github.com/mvnmgrx/kiutils/pull/76
* KiCad 7: DNP token for schematic symbols & labels with `fields_autoplaced` token by mvnmgrx in https://github.com/mvnmgrx/kiutils/pull/77
* KiCad 7: Optional property IDs by mvnmgrx in https://github.com/mvnmgrx/kiutils/pull/78
* KiCad 7: Image with layer token & renamed `Board.graphicalItems` to `Board.graphicItems` by mvnmgrx in https://github.com/mvnmgrx/kiutils/pull/79
* KiCad 7: Netclass flag by mvnmgrx in https://github.com/mvnmgrx/kiutils/pull/80
* Fix issues identified when parsing several hundred kicad 6 and 7 schematics by sAlexander in https://github.com/mvnmgrx/kiutils/pull/73
* Fix: Changes from PR 73 by mvnmgrx in https://github.com/mvnmgrx/kiutils/pull/82
* Feature: Dru severity token by mvnmgrx in https://github.com/mvnmgrx/kiutils/pull/84
* Feature: New plot params since KiCad v7 by mvnmgrx in https://github.com/mvnmgrx/kiutils/pull/85
* KiCad 7: Render caches on text items by mvnmgrx in https://github.com/mvnmgrx/kiutils/pull/87
* KiCad 7: Project instances by mvnmgrx in https://github.com/mvnmgrx/kiutils/pull/88

New Contributors
* hvraven made their first contribution in https://github.com/mvnmgrx/kiutils/pull/59
* sAlexander made their first contribution in https://github.com/mvnmgrx/kiutils/pull/73

**Full Changelog**: https://github.com/mvnmgrx/kiutils/compare/v1.3.0...v1.4.0

Overview
Breaking changes
- Changed: The ID token API was consolidated - (PR 54)
- `SchematicSymbol`: `self.libraryIdentifier` renamed to `self.libId`
- `Symbol`: `self.id` renamed to `self.libId`
- `Footprint`: `self.libraryLink` renamed to `self.libId`
- Setting and getting `self.libId` will update some subtokens of these classes. Check the documentation
for more information on this.
- Changed: `Footprint.create_new()`'s parameter `library_link` renamed to `library_id` - (PR 54)
- Changed: `SymbolLib.version` is now a non-optional token that defaults to the config entry `KIUTILS_CREATE_NEW_VERSION_STR` - (PR 55)

Non-breaking changes
- Added: API for lib_name token in `SchematicSymbol` called `self.libName` - (PR 54)
- Added: Tokens `self.entryName` and `self.libraryNickname` for classes `Symbol`, `SchematicSymbol`
and `Footprint`. These tokens are part of the `libId` token and will be changed when setting
it. - (PR 41)
- Added Tokens `self.unitId` and `self.styleId` for `Symbol` class. These tokens are part of the
`libId` token and will be changed when setting it. - (PR 41)
- Added: All `from_file` and `to_file` methods got a new optional parameter `encoding` to change
the default encoding when reading/writing files. - (PR 50)
- Added: New `active` token in `LibTable` class - (PR 51)
- Added: CONTRIBUTING.md - (PR 52)
- Added: Missing `filePath` attribute in `DesignRules` class - (PR 45)
- Fixed: Return type of `LibTable.create_new()` - (PR 45)
- Fixed: `Position.to_sexpr()` having no parameters - (PR 45)
- Changed: Most parts of the docu were refactored - (PR 45)
- Removed: Unused `size` token in class `Connection()` - (PR 45)
- Removed: Unused `stroke` token in class `Image()` - (PR 45)
- Removed: Some tokens that were defined twice - (PR 45)

All pull requests
* Adding git like differ to the failure test output. by aphera in https://github.com/mvnmgrx/kiutils/pull/42
* Fix: Test report not working in Python 3.11 by mvnmgrx in https://github.com/mvnmgrx/kiutils/pull/44
* Added support for updating children units symbol ID by eeintech in https://github.com/mvnmgrx/kiutils/pull/41
* Fix: Docu refactoring + linting by mvnmgrx in https://github.com/mvnmgrx/kiutils/pull/45
* More tests for new library ID token feature by mvnmgrx in https://github.com/mvnmgrx/kiutils/pull/49
* Feat: Added encoding parameter to file-related functions by mvnmgrx in https://github.com/mvnmgrx/kiutils/pull/50
* Added `active` member to kiutils.libraries.Library for ability to disable specific libraries by zardini123 in https://github.com/mvnmgrx/kiutils/pull/51
* Changes to lower barrier of entry for new contributors by zardini123 in https://github.com/mvnmgrx/kiutils/pull/52
* Feature: Consistent library id APIs for Footprint, Symbol and SchematicSymbol & new lib_name token by mvnmgrx in https://github.com/mvnmgrx/kiutils/pull/54
* Added default version number to SymbolLib by zardini123 in https://github.com/mvnmgrx/kiutils/pull/55

New Contributors
* aphera made their first contribution in https://github.com/mvnmgrx/kiutils/pull/42
* eeintech made their first contribution in https://github.com/mvnmgrx/kiutils/pull/41
* zardini123 made their first contribution in https://github.com/mvnmgrx/kiutils/pull/51

**Full Changelog**: https://github.com/mvnmgrx/kiutils/compare/v1.2.1...v1.3.0

This release fixes the broken packaging config of version v1.2.0. Please update as soon as possible as the prior release is broken.

What's Changed
* Fix setup.cfg by sapristi in https://github.com/mvnmgrx/kiutils/pull/38
* CI: Made tests use a built package instead of src directly by mvnmgrx in https://github.com/mvnmgrx/kiutils/pull/39

New Contributors
* sapristi made their first contribution in https://github.com/mvnmgrx/kiutils/pull/38

**Full Changelog**: https://github.com/mvnmgrx/kiutils/compare/v1.2.0...v1.2.1

This release adds support for Python 3.11 on all platforms. Upgrading from 1.1.4 is highly encouraged, as this release also fixes a critical bug in the class member default values that could lead to unexpected behavior during runtime.

What's Changed
* Feature: ``create_new()`` API for classes that directly serve files by mvnmgrx in https://github.com/mvnmgrx/kiutils/pull/33
* Fix: Made VSCode automatic test discovery work by mvnmgrx in https://github.com/mvnmgrx/kiutils/pull/34
* Fix: Mutable member defaults by mvnmgrx in https://github.com/mvnmgrx/kiutils/pull/35
* Fix: Checked ``self.stroke`` to be None in FpLine.to_sexpr() by mvnmgrx in https://github.com/mvnmgrx/kiutils/pull/36
* Fix: Documentation on Justify.to_sexpr()'s return value by mvnmgrx in https://github.com/mvnmgrx/kiutils/pull/37


**Full Changelog**: https://github.com/mvnmgrx/kiutils/compare/v1.1.4...v1.2.0