Skip to main content

A library to create & manage Archimate files

Project description

pyArchimate package

License Python Version PyPI codecov test Release

Quality Gate Bugs Security Rating Maintainability Docs

Documentation: readthedocs.org

pyArchimate is a Python library for programmatically reading, writing, and manipulating Open Group ArchiMate enterprise architecture models. It has no GUI — it is purely a file I/O and object model library designed for batch and scripting use.

Core concepts

Object What it represents
Model Top-level container for everything
Element An architectural concept (business process, application, server, capability…)
Relationship A typed link between two elements (Association, Realization, Composition, Flow…)
View A diagram — a named subset of elements/relationships laid out visually
Node The visual box representing an element inside a view
Connection The visual arrow representing a relationship inside a view

Elements span the full ArchiMate 3 layer stack: Strategy, Motivation, Business, Application, Technology, Physical, and Implementation.

Supported formats

Format Read Write
ArchiMate Open Exchange XML yes yes
Archi tool format (.archimate) yes yes
ARIS AML yes
CSV yes

Key operations

  • Read / Write / Merge — load one or more files and save to any supported format
  • Create & modify — add elements, relationships, and views via the API without touching a file
  • Filter — extract subsets of elements, relationships, or views by custom predicates
  • Style — set colours, coordinates, dimensions, and text layout on nodes
  • Validate — check for broken references and invalid connections

Limitations

  • No GUI, no diagram renderer
  • No write support for ARIS AML
  • Not designed for interactive or real-time use — batch/scripting oriented

Documentation

  • AI.md — machine-readable reference for AI-assisted tooling and developer onboarding
  • Tutorial — step-by-step guide for new users with runnable code examples

ArchiMate v3.x Compliance

pyArchimate now supports ArchiMate 3.x specification compliance with the following features:

Supported Features

  • BusinessInteraction elements: Full support for creating, importing, and exporting BusinessInteraction elements
  • Influence strength metadata: Complete round-trip preservation of influence relationship strength (both .archimate and OpenGroup formats)
  • Relationship documentation: Full preservation of relationship documentation/description text during import and export

Known Gaps

See Gap Analysis Documentation for detailed analysis of specification alignment and areas for future enhancement (P2/P3).

Metamodel

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyarchimate-1.3.0.tar.gz (76.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pyarchimate-1.3.0-py3-none-any.whl (82.9 kB view details)

Uploaded Python 3

File details

Details for the file pyarchimate-1.3.0.tar.gz.

File metadata

  • Download URL: pyarchimate-1.3.0.tar.gz
  • Upload date:
  • Size: 76.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for pyarchimate-1.3.0.tar.gz
Algorithm Hash digest
SHA256 278cdfc5bdf62cf7860e64ffdaa6a1fa43af17f5c566344adefb2102ad7b9a96
MD5 04e943dc7d592711667c119737bc5f33
BLAKE2b-256 259e85923869b7c4a0fa20fc608e189d40778d2763fd9414b5afe4fef30b77fe

See more details on using hashes here.

Provenance

The following attestation bundles were made for pyarchimate-1.3.0.tar.gz:

Publisher: release.yml on pyArchimate/pyArchimate

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file pyarchimate-1.3.0-py3-none-any.whl.

File metadata

  • Download URL: pyarchimate-1.3.0-py3-none-any.whl
  • Upload date:
  • Size: 82.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for pyarchimate-1.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ffb8d81067746839f55b4f1dc1ec9864aa667758f2fd8261509fe1c803e1c58b
MD5 b2c41839e8bd0f9ed5be9da14bad33e0
BLAKE2b-256 e588eb08dbb2189a16169cd75da2101224caae899f8786d9fe590a03a0f9bb3c

See more details on using hashes here.

Provenance

The following attestation bundles were made for pyarchimate-1.3.0-py3-none-any.whl:

Publisher: release.yml on pyArchimate/pyArchimate

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page