Capellambse

Noteworthy changes

- **New**: More audit events have been added; refer to the new documentation page: [Audit events](https://dsd-dbs.github.io/py-capellambse/start/audit-events.html).

- **New**: The `MelodyModel.description_badge` property has been added, which generates a small SVG diagram showing the overall model complexity (number of objects and diagrams per layer). Thanks, vik378!

<small>(Note that this is intended as a demonstration, and will likely not be expanded. If you need more complex analysis, take a look at the API and design your own!)</small>

- **Deprecated**: The `capellambse.read_attribute` audit event has been renamed to `capellambse.getattr`. For some period of time, both will be fired, but `read_attribute` will eventually be removed.

Full changelog

New features

- **audit**: Add audit events for modifying a model *by Wuestengecko* (216b13bfd1858478120f62450936b6d58dfbfdc4)
- **audit**: Add example class that write-protects a model *by Wuestengecko* (4307d1bdcaff2bbb5dbadb8abed7b381cd6b34ac)
- **reqif**: Implement write support for requirements relations *by ewuerger* (b589e91c034cd34fa84bf2e656d71d0188e23694)
- **reqif**: Show value in repr of `*ValueAttribute` classes *by ewuerger* (cc40227a73981d3083b305efc9a607e4a9a39c1d)
- Introduce model summary badge *by vik378* (bb8371662576c1d3299fbe394e6e6e9ccdb237f4)

Bug fixes

- **model**: Consistently fire read_attribute audit events *by Wuestengecko* (2e63804140f0d905238a9ed16d4d17d457e35771)
- **model**: Don't return None from HTML attributes *by Wuestengecko* (3ee43f28c70844ddeb2aca278d6fffd5f0419058)
- **model**: Fix `AttrProxyAccessor.__set__` method signature *by ewuerger* (5f1835dd2dd979bb671effcfa1e4c247c04b6dc4)
- **pvmt**: Raise correct exception for not-yet-implemented *by Wuestengecko* (6db65924ca4021ffb79270f90e8d6d686ee46e1c)
- Ignore .DS_Store and vscode user settings *by vik378* (20081e5714ba7eeac80c21d3b852b8dd44a9e3d2)

Documentation changes

- **decl**: Remove unused import in demo notebook *by ewuerger* (502d0ee2c06c8bf4be12386e26e06694e97ea02e)
- Add notes on commit requirements *by vik378* (eda6a119ee0af7d43726bfd3860d0c460321ba40)

CI/CD changes

- Update pre-commit config *by Wuestengecko* (c2e00d4e075701327926795e067b6c6fe0ed9ad5)

Unit test changes

- Add testcase for setting `.values` on `EnumValueAttribute` *by ewuerger* (2f514118029916aceba84842799290f9ff38b729)
- Load model extensions before test discovery *by Wuestengecko* (5761d50eb90d2bc69f14f992cd7d2205564a3004)

Code refactorings

- **audit**: Rename `read_attribute` event to `getattr` *by Wuestengecko* (ba5c0a1473ac8bcf58852e4723d5dae4e3582784)
- **reqif**: Make ReqIF extension standards-compliant *by Wuestengecko* (06a5deaf8d2e0699cdfc6ebd63ba52d0157c27d6)

New features

- **model**: Add nesting for OperationalActivity and SystemComponent *by Wuestengecko* (80894f4e732d4108268e30c69171727471a6b740)
- **model**: Implement the terminal graphics protocol *by Wuestengecko* (e70e4526989073ea869a5a7571f082e49362c85a)
- Implement diagram cache with native diagrams *by jamilraichouni* (d9a6a5bf3fec6de3604361b3cdad459c0933c941)
- Solution to write project files in tmp dir *by jamilraichouni* (3a1d874da74d4c99db34ee9ba27cb14cf128d762)

Bug fixes

- **cli**: Improve option handling under click *by Wuestengecko* (703ec94d627364c7c2969dec830bbe0ffa828726)
- **loader**: Fix `stacklevel` on raised warning *by Wuestengecko* (0578db59e40e6dd569877386beb1acf0136f3f05)

Documentation changes

- **README**: Add more badges *by Wuestengecko* (482da1533c6ce2aa985af11048a94fee8b67a5df)
- Add svgwrite to Intersphinx *by Wuestengecko* (aec7111e34d285671a8bdbc7734124ac52d016df)

Build system changes

- **docs**: Add `serve` convenience make target *by Wuestengecko* (c2c6ffb1e6588f8e84ae770f1ffb46e403949aeb)

New features

- **diagram**: Add `get_styleclass` function *by ewuerger* (0450bcd9b68969e5fd8448b6ead1b299552ddb45)
- **model**: Add `ControlNode` to `fa` crosslayer *by ewuerger* (f19f0169c27129c933ad06980343c01606a1471e)
- **model**: Add `PortAllocation` and implement `TraceableElement` *by ewuerger* (4578c0c75e20ef4c338a99f490776bfe6318f546)
- **model**: Add `members` attribute to `information.Association` *by ewuerger* (6440041c520ef134e5e5447ba6c400fb2c6cc976)
- **repl**: Accept a JSON string as model argument *by Wuestengecko* (990069fc308018a0aeff1a8278c13cdac2367b63)

Bug fixes

- **filehandler**: Simplify PathLike handling in split_protocol *by Wuestengecko* (ba3d17450f720efea5538d0c7026e6fc5f9fb222)
- **git**: Don't silence errors during worktree creation *by Wuestengecko* (b2714b5754471339151cd2cc7d229cd920e84d22)

Code refactorings

- **git**: Simplify log levels of subprocess calls *by Wuestengecko* (d2b763a4680f546a538396798449137a8f8ecbd6)
- **model**: Remove an unused import *by ewuerger* (6bb4fba96ab86f39536b7d2c2125a20838530636)
- **model**: Remove unused xtype from globals *by ewuerger* (7c13ca6ccb03e039b590c8b5af7b4620a3237b76)

Bug fixes

- **model**: Solved bug in ComponentExchange.exchange_items *by juanitocalero* (530e3770fa43952107bfa54f5496a3d8b69b7188)

New features

- **diagram**: Publish `StyleOverrides` type *by ewuerger* (a6bd4cd499727838d0ae1373d89661be0663962f)
- **model**: Enable writing on more model elements *by Wuestengecko* (9484d2fcb157e27745e88fcae0827116c1fc8b01)
- **model**: Enforce uniqueness on lists of links *by Wuestengecko* (5bff91a191cd10efdb2d7004f1f3b7efc3af4fdd)
- **model**: Implement the special logic for `PhysicalLink.ends` *by Wuestengecko* (4967ace69b28c55784e4d258b2de0756158102bd)

Bug fixes

- **model**: Add missing `PhysicalPort.exchanges` *by ewuerger* (18571b3fd3b4a9c41da353e43449c71f64d6975a)
- **model**: Fix class-level access to DeprecatedAccessor *by Wuestengecko* (cd2bba62cada73813cdc195eeacf7563d698c582)

Unit test changes

- **model**: Fix naming of `cs` test cases *by ewuerger* (1c4997ef906af2e9cc5903bd118b7f45daa6c0a5)

Code refactorings

- **model**: Untangle calls between Accessor and coupled ElementList *by Wuestengecko* (5a755f05021c2c79afb1ce63f6f04d6e3195a790)
- Fix bad type error about GenericElement.diagrams *by Wuestengecko* (b68449327d857ecfc7093dd085d63cbec994e3d8)
- Remove legacy cache directory migration *by Wuestengecko* (aa4cff3ba6d61e4c879d43cd0031d54d5c80ac0c)
- Restructure diagram related modules *by Wuestengecko* (d0accbfaf991683bbdc2c3581a48c9bf6efb3702)
- Restructure filehandler subpackage *by Wuestengecko* (5adf61f45eaea1a8c77f5c4393195d874e3ecee5)

New features

- **model**: Export GenericElement and ElementList on capellambse.model *by Wuestengecko* (fa25f53f097037ec0b4bb85d6ddffa26839673fa)
- **model**: Implement Scenario and related classes *by Wuestengecko* (0f914f0f5883032243972a678e8afe0d8f1fa6a1)
- **model**: Make `elemclass` optional in `ElementList` *by Wuestengecko* (03d8a5fdf1618a79f9c16481377ff5bf143589f0)
- **reqif**: Recognize `datetime` as alias for `DateValueAttribute` *by Wuestengecko* (ddd4ef7a7266f7767b42427d2d69c58f5cad2067)
- Add `Association`s to information crosslayer *by ewuerger* (cbe3b27fe4c644abc93ccb7468c00595381e66b5)
- Add `kind` attribute to class properties *by ewuerger* (b395ab85408819bfbb66779fd9ae23494335665f)

Bug fixes

- **model**: Don't invent names for unnamed elements *by Wuestengecko* (b2e09f3999d76be164e8c3f5239d6db3a0afabb6)
- **model**: Remove legacy `__str__` from ElementList *by Wuestengecko* (02c7de1f8e57add2f5334682408598485faed08d)
- **reqif**: Fix incorrect format for DateValueAttribute *by Wuestengecko* (4a61d0dff1bddd25d36a0fda3faf4658e36ffbe3)

Documentation changes

- Add LXML to intersphinx mapping *by ewuerger* (53000f826b0b3ff1da5033282465ad4762f0b058)
- Add `summary` demo for the association *by ewuerger* (1ad672b4c7c872cf45a3057bb0bef3daaba05a35)
- Document the "low-level" model API *by Wuestengecko* (5cd7987f0862f70e2b4720c9a396d40d4904e427)
- Update `Data Values` intro notebook *by ewuerger* (45305cb3358b4549275fa52bdf42b4d8eeb61bba)

Code refactorings

- **loader**: Deprecate `find_by_xsi_type` in favor of `iterall_xt` *by Wuestengecko* (57a6bef4551803b30f85bb179eab452bb860af95)
- **model**: Improve `Association` property definitions *by Wuestengecko* (ead9beeee174e4afd83dbc697d6769248189578e)