Capellambse

Noteworthy changes

- capellambse now supports access to basic PropertyValue and PropertyValueGroup objects in the model. (This is a prerequisite for the Property Value Management extension update / refactoring.)

- The `_ElementTree` reference at *ModelFile.tree* is now deprecated; use *ModelFile.root* instead.

Full changelog

New features

- **loader**: Read Capella version from referenced viewpoints *by Wuestengecko* (2c25f26e4a311625030a9693b8c2b18980259217)
- **model**: Add property-value related attributes to `MelodyModel` *by Wuestengecko* (c1355e1e5750e25ea73b590d047b824cc643b14b)
- **model**: Implement dict-like setting of values *by Wuestengecko* (49e56715233bb1dfc22710333b5cdebc52f4a4af)

Bug fixes

- **model**: Add namespaces when creating elements *by Wuestengecko* (7e359c87eae28a54adf8252743182e4a173baa5c)
- **model**: Fix typing for `ElementList.__getitem__` *by Wuestengecko* (f178e2a2beb6052780d673dc2f2de2f6b600bf00)
- **model**: Make `model.info` read-only *by Wuestengecko* (d0fa8527f8bf07eceba7ee8b5d5ee224ed3a48fc)

Documentation changes

- **apidoc**: Put module contents before submodules *by Wuestengecko* (36421f69709c9547a4be9cbf14f3dd180c3ce888)
- **reqif**: Add deprecation notice to `reqif.elements` *by Wuestengecko* (4f1383ccd3743d12bdf9f14e864e099a53f6748b)

CI/CD changes

- Update black to 23.1.0 *by Wuestengecko* (471dd0b29f65370c2a6ffe5067bc053677a71d48)

Code refactorings

- **loader**: Deprecate ModelFile.tree *by Wuestengecko* (d15a5b70c8ca5a6467d2c9da6e77dae34e87ce8c)

This fixes issues with new functionality from the previous release. Sorry!

Bug fixes

- **metrics**: Fix casing of SVG root element *by Wuestengecko* (04fb0bd471f8a111aa745e5caaea5bab7595f9e3)

Documentation changes

- **examples**: Add missing header to Complexity Assessment notebook *by Wuestengecko* (592ef4047b26e82d3e4c065cf94cb40e623bee23)

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)