capellambse v0.5.12

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

Bug fixes

• metrics: Fix casing of SVG root element by @Wuestengecko (04fb0bd)

Documentation changes

• examples: Add missing header to Complexity Assessment notebook by @Wuestengecko (592ef40)

capellambse v0.5.11

Noteworthy changes

• New: More audit events have been added; refer to the new documentation page: Audit events.

• 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!

  (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!)

• 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 (216b13b)
• audit: Add example class that write-protects a model by @Wuestengecko (4307d1b)
• reqif: Implement write support for requirements relations by @ewuerger (b589e91)
• reqif: Show value in repr of *ValueAttribute classes by @ewuerger (cc40227)
• Introduce model summary badge by @vik378 (bb83716)

Bug fixes

• model: Consistently fire read_attribute audit events by @Wuestengecko (2e63804)
• model: Don't return None from HTML attributes by @Wuestengecko (3ee43f2)
• model: Fix AttrProxyAccessor.__set__ method signature by @ewuerger (5f1835d)
• pvmt: Raise correct exception for not-yet-implemented by @Wuestengecko (6db6592)
• Ignore .DS_Store and vscode user settings by @vik378 (20081e5)

Documentation changes

• decl: Remove unused import in demo notebook by @ewuerger (502d0ee)
• Add notes on commit requirements by @vik378 (eda6a11)

CI/CD changes

• Update pre-commit config by @Wuestengecko (c2e00d4)

Unit test changes

• Add testcase for setting .values on EnumValueAttribute by @ewuerger (2f51411)
• Load model extensions before test discovery by @Wuestengecko (5761d50)

Code refactorings

• audit: Rename read_attribute event to getattr by @Wuestengecko (ba5c0a1)
• reqif: Make ReqIF extension standards-compliant by @Wuestengecko (06a5dea)

capellambse v0.5.10

New features

• model: Add nesting for OperationalActivity and SystemComponent by @Wuestengecko (80894f4)
• model: Implement the terminal graphics protocol by @Wuestengecko (e70e452)
• Implement diagram cache with native diagrams by @jamilraichouni (d9a6a5b)
• Solution to write project files in tmp dir by @jamilraichouni (3a1d874)

Bug fixes

• cli: Improve option handling under click by @Wuestengecko (703ec94)
• loader: Fix stacklevel on raised warning by @Wuestengecko (0578db5)

Documentation changes

• README: Add more badges by @Wuestengecko (482da15)
• Add svgwrite to Intersphinx by @Wuestengecko (aec7111)

Build system changes

• docs: Add serve convenience make target by @Wuestengecko (c2c6ffb)

capellambse v0.5.9

New features

• diagram: Add get_styleclass function by @ewuerger (0450bcd)
• model: Add ControlNode to fa crosslayer by @ewuerger (f19f016)
• model: Add PortAllocation and implement TraceableElement by @ewuerger (4578c0c)
• model: Add members attribute to information.Association by @ewuerger (6440041)
• repl: Accept a JSON string as model argument by @Wuestengecko (990069f)

Bug fixes

• filehandler: Simplify PathLike handling in split_protocol by @Wuestengecko (ba3d174)
• git: Don't silence errors during worktree creation by @Wuestengecko (b2714b5)

Code refactorings

• git: Simplify log levels of subprocess calls by @Wuestengecko (d2b763a)
• model: Remove an unused import by @ewuerger (6bb4fba)
• model: Remove unused xtype from globals by @ewuerger (7c13ca6)

capellambse v0.5.8

Bug fixes

• model: Solved bug in ComponentExchange.exchange_items by @juanitocalero (530e377)

capellambse v0.5.7

New features

• diagram: Publish StyleOverrides type by @ewuerger (a6bd4cd)
• model: Enable writing on more model elements by @Wuestengecko (9484d2f)
• model: Enforce uniqueness on lists of links by @Wuestengecko (5bff91a)
• model: Implement the special logic for PhysicalLink.ends by @Wuestengecko (4967ace)

Bug fixes

• model: Add missing PhysicalPort.exchanges by @ewuerger (18571b3)
• model: Fix class-level access to DeprecatedAccessor by @Wuestengecko (cd2bba6)

Unit test changes

• model: Fix naming of cs test cases by @ewuerger (1c4997e)

Code refactorings

• model: Untangle calls between Accessor and coupled ElementList by @Wuestengecko (5a755f0)
• Fix bad type error about GenericElement.diagrams by @Wuestengecko (b684493)
• Remove legacy cache directory migration by @Wuestengecko (aa4cff3)
• Restructure diagram related modules by @Wuestengecko (d0accbf)
• Restructure filehandler subpackage by @Wuestengecko (5adf61f)

capellambse v0.5.6

New features

• model: Export GenericElement and ElementList on capellambse.model by @Wuestengecko (fa25f53)
• model: Implement Scenario and related classes by @Wuestengecko (0f914f0)
• model: Make elemclass optional in ElementList by @Wuestengecko (03d8a5f)
• reqif: Recognize datetime as alias for DateValueAttribute by @Wuestengecko (ddd4ef7)
• Add Associations to information crosslayer by @ewuerger (cbe3b27)
• Add kind attribute to class properties by @ewuerger (b395ab8)

Bug fixes

• model: Don't invent names for unnamed elements by @Wuestengecko (b2e09f3)
• model: Remove legacy __str__ from ElementList by @Wuestengecko (02c7de1)
• reqif: Fix incorrect format for DateValueAttribute by @Wuestengecko (4a61d0d)

Documentation changes

• Add LXML to intersphinx mapping by @ewuerger (53000f8)
• Add summary demo for the association by @ewuerger (1ad672b)
• Document the "low-level" model API by @Wuestengecko (5cd7987)
• Update Data Values intro notebook by @ewuerger (45305cb)

Code refactorings

• loader: Deprecate find_by_xsi_type in favor of iterall_xt by @Wuestengecko (57a6bef)
• model: Improve Association property definitions by @Wuestengecko (ead9bee)

capellambse v0.5.5

New features

• loader: Allow ignoring CorruptModelError from duplicate UUIDs contributed by @Wuestengecko (f45ac44)
• model: Log cache misses when rendering diagrams contributed by @Wuestengecko (e04f70b)

Bug fixes

• reqif: Fix repr of relations contributed by @Wuestengecko (0e22a12)

Build system changes

• Officially support Python 3.11 contributed by @Wuestengecko (d332f39)

CI/CD changes

• Disable the "refactorings" checker in GH Actions contributed by @Wuestengecko (e3a4721)
• Fix all pylint warnings contributed by @ewuerger (6f6dcc3)
• Warn about unnecessary type:ignore comments contributed by @Wuestengecko (360b120)

Code refactorings

• Simplify _short_repr_ of ReqIFElements and Relations contributed by @ewuerger (cb9cdc2)

v0.5.4

New features

• model: Make AttrProxyAccessor writable contributed by @Wuestengecko (409e63b)
• repl: Add more convenience imports and functions contributed by @Wuestengecko (e8426f4)
• Add entries and exits attribute to capellacommon.States contributed by @ewuerger (df3e67d)
• Add realization attributes to Classes contributed by @ewuerger (2ce17c8)

Bug fixes

• loader: Fix DeprecationWarning when looking for file handlers contributed by @Wuestengecko (7f9746a)
• model: Fix del x[-1] on coupled ElementLists contributed by @Wuestengecko (54c90c2)
• model: Fix display of warnings contributed by @Wuestengecko (7b7dad9)
• Fill in tag for LinkAccessors contributed by @ewuerger (4ad7060)
• Fix definition of GenericElement.parent contributed by @Wuestengecko (a58970b)

Documentation changes

• model: Fix / update docstrings for Accessors contributed by @Wuestengecko (b0590cd)
• Extend documentation of extend contributed by @ewuerger (a54956e)
• Update example notebooks contributed by @ewuerger (600cef8)

CI/CD changes

• Require Sphinx v5+ contributed by @Wuestengecko (b419bfa)

Code refactorings

• aird: Demote "No default style" warnings to DEBUG level contributed by @Wuestengecko (f77d065)
• model: Extract deprecated-alias logic to an Accessor contributed by @Wuestengecko (d4a8663)
• Rename create operation to extend contributed by @ewuerger (617900d)

v0.5.3

What's Changed

• Add StateTransition.effects by @Wuestengecko in #174

Full Changelog: v0.5.2...v0.5.3