sofaman 0.1.7

Model your architecture in an easy to understand language inspired by Yaml, and generate XMI (UML2) and PlantUML outputs.

SofaMan

SofaMan is an easy to use software architecture modeling language inspired by YAML. It is designed to be easy to read and write, and to be easily converted to other modeling language formats. At present there are two languages supported, XMI (UML2) and PlantUML.

The project uses Pixi for project management.

Example

The following shows an example model using the SofaMan modeling language.

#
# Sample sofa model.
#

package Retail.CRM:
    visibility: public

stereotype Regulatory: [GDPR]
stereotype Security: [PIDRelevant]

actor Client
actor RelationshipManager

component RESTService:
    ports: [443]

component CustomerDB:
    name: Customer Database
    description:|
        Holds customer data
    stereotypes: [Regulatory.GDPR]
    package: Retail.CRM
    ports: [443, REST]

component CustomerSearch(RESTService):
    package: Retail
    ports: [443]

relation CustomerSearch@443 flow CustomerDB@REST:
    name: Execute search query
    description: |
        Search for customers by name or address
    stereotypes: [Regulatory.GDPR]

The above model generates the following PUML.

@startuml sample
allowmixing

actor Client 

actor RelationshipManager 

component RESTService  {
    port 443
}

package Retail.CRM { 
component CustomerDB <<GDPR>> {
    port 443
    port REST
}
 
}
package Retail { 
component CustomerSearch  {
    port 443
}
 
}
443 ..> REST

@enduml

All the supported modeling syntax can be found in tests/test_cases/full_all.sofa

Usage

Run

pixi run python sofaman/sofamangen.py --help

Run tests

pixi run test

Test coverage

pixi run coverage

Documentation

pixi run doc

The latest documentation can be found at: https://ruhati.net/sofaman/

Using without Pixi

pip install sofaman
python -m sofaman.sofamangen --help

Generate UML2 XMI

python -m sofaman.sofamangen generate a_model.sofa a_model.xmi

If you already have a XMI file and want to ensure updates to it are done using the same IDs (so as to preserve the diagram and other elements)

1. Generate the ID file

   python -m sofaman.sofamangen export a_model.xmi a_model_id.json
   

2. You can use the id file while re-generating the XMI

   python -m sofaman.sofamangen generate a_model.sofa a_model.xmi --ids_file