Capellambse

Noteworthy changes

- capellambse now supports some aspects of the [Capella Filtering extension](https://github.com/eclipse/capella-filtering).

Full changelog

New features

- **glart**: Add more debug logging *by Wuestengecko* (2a5ed35cd722895ed515ddf21742771b11453d3e)
- **glart**: Allow passing tokens with Gitlab CI "File" variables *by Wuestengecko* (633a9844202918ee31432c49821f9a36e2121028)
- **model**: Extend exports at `capellambse.model` *by Wuestengecko* (604b9897b7ac8748adcb6e57d1ee963b3780b21a)
- Add `min_card` and `max_card` to `ExchangeItemElement` *by thithi47* (f6d5774b986f0472c2ed0a6e9903a86b407047a6)
- Implement basic support for the Filtering extension *by Wuestengecko* (9fa100b92e30cfad575712abbad5e1cb4fdc72d7)

Bug fixes

- **glart**: Treat 404 as file not found *by Wuestengecko* (39bdf1885663aabe829738e50eda9bd793c846e6)
- **loader**: Don't return Nones from `follow_links` *by Wuestengecko* (fc80f680b2a2325580b951b0f66ae585aea84790)
- **model**: Tell mypy about arbitrary `MelodyModel` attributes *by Wuestengecko* (17f38e576d44fbc8553eaf43edb21e17f43eab13)
- Fix message for errors in model extension loading *by Wuestengecko* (0d4a893738ba0d05ee002dc924eb930334cd9e45)

Documentation changes

- **diagram**: Fix autodocs about `capellambse.diagram` *by Wuestengecko* (c9a8ca235b7776d6fd921ba2ab1da9c58820ceda)

CI/CD changes

- Update to mypy v1.0.0 *by Wuestengecko* (c5382c618de86d3d87464e7d3cb1f0650ea9584b)

Code refactorings

- **diagram**: Fix typing issues and optimize imports *by Wuestengecko* (7ba6fa54ad4ae8fbe7db95e7d040effde46eceea)
- **model**: Make `GenericElement.__getattr__` type-checking only *by Wuestengecko* (75103aade8893d85870a3b5e1b1b570d30b0c8f7)
- **model**: Stop using `CustomAccessor` *by Wuestengecko* (d8eedb963d3b7b3e6a7f018552fd4960ad9e792d)

Noteworthy changes

In addition to the "master" branch, where development takes place, and the usual fixed release tags, we now have the additional branch "release-0.5". This branch always points to the latest released tag in the v0.5 line, and may be used in places where automatic updates are desired, but the stability guarantees from semantic versioning are also necessary. (Similar branches will be created for future release lines.)

This release branch works well in conjunction with the new CI template and other types of continuous integration or deployment.

Full changelog

New features

- **loader**: Support extended `.afm` format *by ewuerger* (1cdd1e82b01ca9b91f887319ad0747c1811b3d73)
- Add Gitlab CI template for model complexity badge *by MoritzWeber0* (7306f2646861396f4fa0701cfe2912a3cb5fc6f4)

New features

- **filehandler**: Add a Gitlab artifact file handler *by Wuestengecko* (e9861f2f2a709fdd4b2490671268b2d0894858a4)

Bug fixes

- **model**: Fix stacking of subdirs in `diagram_cache` *by Wuestengecko* (439b75626bed1870ee787514ab37f04fef31c0f8)

CI/CD changes

- Add pre-commit hook for pylint *by Wuestengecko* (1b4a93bdf75b9500dd6ae735cf011f8730ea28d6)
- Fix inconsistent mypy check results *by Wuestengecko* (b619b60d32644c5482674fc0d4bcdcb6fb78a009)

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)