Skip to main content

Crunch-UML

Crunch_UML is a parser for XMI files originating from UML tools such as Enterprise Architect. The tool reads the XMI and stores entities and relationships in an SQLite database for further analysis or use.

Build Status Coverage Status PyPi Licence

  • Parses entities such as Package, Class, and Relation from an XMI file.
  • Uses SQLAlchemy for database access and manipulation.
  • Imports different input formats into the databases
  • Saves all imported data to SQLAlchemy database
  • Can use different schema's within the same database to hold different datamodels
  • Supports Upserts to be able to import different datasets, changes to datasets etc.
  • Exports to different output formats: Excel, JSON, CSV, Jinja2 templating, Markdown

Install and Usage

Install using pip:

pip install crunch-uml

and start the program like so:

crunch_uml [-h] [-v] [-d] [-db_url DATABASE_URL] [-sch] {import,transform,export} ...

or download repository, install packages as they are described in setup.py, got to the root of the downloaded files and start the program like so:

python ./crunch_uml/cli.py [-h] [-v] [-d] [-db_url DATABASE_URL] [-sch] {import,transform,export} ...

General Options:

  • -h, --help: Show this help message and exit.
  • -v, --verbose: Set log level to INFO.
  • -d, --debug: Set log level to DEBUG.
  • -db_url DATABASE_URL, --database_url DATABASE_URL: URL of the crunch_uml database. Supports any SQLAlchemy (https://docs.sqlalchemy.org/en/20/dialects/) compatible database. The default is sqlite:///crunch_uml.db.
  • -sch SCHEMA, --schema_name SCHEMA: Name of the schema that will be used. Different models can be loaded into different schema's in the samen database. For export one schema should used.

Commands:

  • import: Import data to the Crunch UML database.

    • -h, --help: Show this help message and exit.
    • -db_create, --database_create_new: Create a new database and discard the existing one.
    • -f INPUTFILE, --inputfile INPUTFILE: Path to import file.
    • -url URL: URL for import
    • -t INPUTTYPE, --inputtype INPUTTYPE: Specifies input type from the following: ['xmi', 'eaxmi', 'json', 'xlsx', 'csv'].
    • --skip_xmi_relations: Skip parsing relations for XMI files only.

    Supported Input Types:

    • xmi: XMI Parser for strict XMI files. No extensions, like EA extensions, are parsed. Tested on XMI v2.1 spec.
    • eaxmi: XMI Parser that processes EA (Enterprise Architect) specific extensions. Tested on XMI v2.1 spec.
    • json: Generic parser that reads JSON files and looks for table and column definitions.
    • xlsx: Generic parser that reads Excel files, expecting one or more worksheets that correspond with the names of one or more tables.
    • csv: Generic parser that reads a single CSV file, expecting its name to be in the list of tables.

    The following tables are supported: ['packages', 'classes', 'attributes', 'enumerations', 'enumerationliterals', 'associations', 'generalizations'].

  • export: Export data from the Crunch UML database.

    • -h, --help: Show this help message and exit.
    • -f OUTPUTFILE, --outputfile OUTPUTFILE: Specify the output file.
    • -t OUTPUTTYPE, --outputtype OUTPUTTYPE: Specifies output type from the following: ['jinja2', 'ggm_md', 'json', 'csv', 'xlsx'].
    • -pi OUTPUT_PACKAGE_IDS, --output_package_ids OUTPUT_PACKAGE_IDS: List of package IDs separated by commas.
    • -xpi OUTPUT_EXCLUDE_PACKAGE_IDS, --output_exclude_package_ids OUTPUT_EXCLUDE_PACKAGE_IDS: List of package IDs to be excluded from the output, separated by commas.
    • -jtd OUTPUT_JINJA2_TEMPLATEDIR, --output_jinja2_templatedir OUTPUT_JINJA2_TEMPLATEDIR: Directory for Jinja2 templates.
    • -jt OUTPUT_JINJA2_TEMPLATE, --output_jinja2_template OUTPUT_JINJA2_TEMPLATE: Specific Jinja2 template file.

    Supported Export Types:

    • jinja2: Renderer using Jinja2 to render one file per model in the database, where a model refers to a package with at least one Class. Requires "output_jinja2_template" and "output_jinja2_templatedir".
    • ggm_md: Renderer that produces a basic markdown file per model in the database, where a model refers to a package containing at least one Class.
    • json: Produces a JSON document where each element relates to a table in the data model.
    • csv: Produces multiple CSV files, each corresponding to a table in the data model.
    • xlsx: Produces an Excel sheet with tabs corresponding to tables in the data model.
    • ttl: Renderer that renders Linked Data ontology in turtle from the supplied models, where a model is a package that includes at least one Class. Needs parameter "output_lod_url".
    • rdf: Renderer that renders Linked Data ontology in RDF from the supplied models, where a model is a package that includes at least one Class. Needs parameter "output_lod_url".
    • json_schema: Render JSON-Schema from a model using a base class as starting point and use outgoing associations only. Needs parameter "json_schema_url".
  • transform: Transfrom the datamodel from one schema to a datamodel in another schema.

    • -sch_from, --schema_from: Schema in database om het datamodel uit te lezen, standaard waarde is 'default'.
    • -sch_to, --schema_to: Schema in database om het getransformeerde datamodel naar te schrijven.
    • -ttp, --transformationtype: Geeft transformationtype aan. Beschikbare types zijn: 'copy', 'transform'.
    • -rt_pkg, --root_package: Geeft het root package dat getransformeerd moet worden.
    • -m_gen, --materialize_generalizations: Kopieert alle attributen van bovenliggende klassen naar de onderliggende klassen. Alle strings anders dan "True" worden geïnterpreteerd als False.
    • -plug_mod, --plugin_file_name: Naam (inclusief pad) van het Python-bestand dat de transformation plugin bevat die dynamisch geladen moet worden.
    • -plug_cl, --plugin_class_name: Naam van de klasse binnen de module die de transformation plugin implementeert. De klasse moet een subklasse zijn van 'crunch_uml.transformers.plugin.Plugin'.

Development

# Get a comprehensive list of development tools
make help

Future Improvements

  • Expansion to other database backends such as PostgreSQL or MySQL.
  • Export XMI, Turtle (Linked Data)
  • Develop more Jinja2 templates
  • Perform checking
  • Direct access to repositories (import and export)

Metadata

Release files for crunch-uml 0.2.10

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for crunch-uml 0.2.10
File Size Uploaded Provenance Actions
crunch_uml-0.2.10.tar.gz 5.8 MB Without provenance Details for crunch_uml-0.2.10.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for crunch-uml 0.2.10
File Interpreter ABI Platform Actions
crunch_uml-0.2.10-py3-none-any.whl Python 3 none any Details for crunch_uml-0.2.10-py3-none-any.whl

Total release size: 5.8 MB

Release files / crunch_uml-0.2.10.tar.gz

Download URL crunch_uml-0.2.10.tar.gz
Size 5.8 MB
Tags Source
SHA-256 checksum
How to use checksums
724bbd3f9ed9cc1a2fbdd07edb7af9116802b868882f78fa294617cea93e46bd
BLAKE2b-256 checksum
How to use checksums
49d13b43c6dd7c379749307d62bc2869d8c75bfdc75e1b7048d8924b06debdf1
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.0 CPython/3.12.4

Release files / crunch_uml-0.2.10-py3-none-any.whl

Download URL crunch_uml-0.2.10-py3-none-any.whl
Size 46.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
3921dec85e651b0a04ab9edff16d007dffb37a18d268de22dc2d90b11b656b4a
BLAKE2b-256 checksum
How to use checksums
08cee1ebfa6aa9dc26db0fbeb76a733f45a085a2f1505fbd0dfd15dacec7327f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.0 CPython/3.12.4

Security for crunch-uml 0.2.10

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.2.10 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page