https://github.com/stariongroup/uml4net
C# library to read UML version 2.5.1 models
https://github.com/stariongroup/uml4net
modeltopia uml
Last synced: about 2 months ago
JSON representation
C# library to read UML version 2.5.1 models
- Host: GitHub
- URL: https://github.com/stariongroup/uml4net
- Owner: STARIONGROUP
- License: apache-2.0
- Created: 2019-02-25T13:52:58.000Z (about 7 years ago)
- Default Branch: development
- Last Pushed: 2025-09-17T08:28:42.000Z (7 months ago)
- Last Synced: 2025-10-06T23:18:18.036Z (6 months ago)
- Topics: modeltopia, uml
- Language: C#
- Homepage:
- Size: 57.9 MB
- Stars: 5
- Watchers: 1
- Forks: 3
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Citation: CITATION.cff
- Notice: NOTICE
Awesome Lists containing this project
README
# Introduction
Uml4net is a suite of dotnet core libraries and tools that are used to deserialize (read) a UML version 2.5.1 model in XMI form. Uml4net is typically used to support opinionated template based code-generation and is a part of `modeltopia`. Uml4net porivdes a number of libraries that are described in the following sections.
## uml4net
The core library that contains all the class definitions as they appear in the UML 2.5.1 specification. Together with uml4net.xmi it provides the capability to to read UML models and make them available as an in-memory object graph.
## uml4net.Extensions
The **uml4net.Extensions** library provides extensions methods to the uml4net library to support code generation. This library is part of the uml4net ecosystem.
## uml4net.xmi
The **uml4net.xmi** library provides an XMI reader implementation to read UML XMI model files.
> To learn more about how to read an UML model, read about it [here](https://github.com/STARIONGROUP/uml4net/wiki/uml4net.xmi.project)
## uml4net.xmi.Extensions.EnterpriseArchitect
The **uml4net.xmi.Extensions.EnterpriseArchitect** library is a specific XMI Reader extension to support Enterprise Architect XMI reading.
## uml4net.HandleBars
The **uml4net.HandleBars** library provides [HandleBars](https://github.com/Handlebars-Net/Handlebars.Net) helpers to support code generation. This library is part of the uml4net ecosystem.
## uml4net.Reporting
The **uml4net.Reporting** library contains reporting generators. This library is part of the uml4net ecosystem.
## uml4net.Tools
The **uml4net.Tools** commandline application is used to generate reports on the content of the UML model. Find the documentation [here](https://github.com/STARIONGROUP/uml4net/wiki/uml4net.Tools).
# Code Quality
[](https://sonarcloud.io/summary/new_code?id=STARIONGROUP_uml4net)
[](https://sonarcloud.io/summary/new_code?id=STARIONGROUP_uml4net)
[](https://sonarcloud.io/summary/new_code?id=STARIONGROUP_uml4net)
[](https://sonarcloud.io/summary/new_code?id=STARIONGROUP_uml4net)
[](https://sonarcloud.io/summary/new_code?id=STARIONGROUP_uml4net)
[](https://sonarcloud.io/summary/new_code?id=STARIONGROUP_uml4net)
[](https://sonarcloud.io/summary/new_code?id=STARIONGROUP_uml4net)
[](https://sonarcloud.io/summary/new_code?id=STARIONGROUP_uml4net)
[](https://sonarcloud.io/summary/new_code?id=STARIONGROUP_uml4net)
[](https://sonarcloud.io/summary/new_code?id=STARIONGROUP_uml4net)
# Installation
The package are available on Nuget at:
- [uml4net](https://www.nuget.org/packages/uml4net): 
- [uml4net.Extensions](https://www.nuget.org/packages/uml4net.Extensions): 
- [uml4net.xmi](https://www.nuget.org/packages/uml4net.xmi): 
- [uml4net.HandleBars](https://www.nuget.org/packages/uml4net.HandleBars): 
- [uml4net.Reporting](https://www.nuget.org/packages/uml4net.Reporting): 
- [uml4net.Tools](https://www.nuget.org/packages/uml4net.Tools): 
- [uml4net.xmi.Extensions.EnterpriseArchitect](https://www.nuget.org/packages/uml4net.xmi.Extensions.EnterpriseArchitect): 
# Reading a UML model
Reading a UML model is straightforward and is done using the an `IXmiReader`. An instance of `IXmiReader` is created using the `XmiReaderBuilder`. Once the reader is available, point it to a UML model you want to read and you're of to the races:
```
var reader = XmiReaderBuilder.Create()
.Build();
var xmiReaderResult = reader.Read("path-to-your-model");
var rootPackage = xmiReaderResult.QueryRoot("");
```
The `IXmiReader` can be configured with an `IXmiReaderSettings`, read more about reading an XMI document [here](https://github.com/STARIONGROUP/uml4net/wiki/uml4net.xmi.project)
The `IXmiReader` is able to read and process **StereoTypes** as they are applied to UML model elements. Read more about that [here](https://github.com/STARIONGROUP/uml4net/wiki/ProfilesAndStereoTypes)
# Build Status
GitHub actions are used to build and test the uml4net libraries
Branch | Build Status
------- | :------------
Master | 
Development | 
# UML Documentation
The Object Management Group (OMG) is an international technology standards consortium. It was founded in 1989 with the goal of creating and maintaining vendor-neutral, interoperable, and portable standards for distributed computing. UML is one of the standards provided by OMG at http://www.omg.org/spec/UML/
# Software Bill of Materials (SBOM)
As part of our commitment to security and transparency, this project includes a Software Bill of Materials (SBOM) in the associated NuGet packages. The SBOM provides a detailed inventory of the components and dependencies included in the package, allowing you to track and verify the software components, their licenses, and versions.
**Why SBOM?**
- **Improved Transparency**: Gain insight into the open-source and third-party components included in this package.
- **Security Assurance**: By providing an SBOM, we enable users to more easily track vulnerabilities associated with the included components.
- **Compliance**: SBOMs help ensure compliance with licensing requirements and make it easier to audit the project's dependencies.
You can find the SBOM in the NuGet package itself, which is automatically generated and embedded during the build process.
# License
The uml4net libraries are provided to the community under the Apache License 2.0.
# Contributions
Contributions to the code-base are welcome. However, before we can accept your contributions we ask any contributor to sign the Contributor License Agreement (CLA) and send this digitaly signed to s.gerene@stariongroup.eu. You can find the CLA's in the CLA folder.
[Contribution guidelines for this project](.github/CONTRIBUTING.md)