Accellera SPIRIT/IP-XACT DE (Design Environment) and Python Bindings

IP-XACT DE

Category

Status

CI/CD

01. PR title 02. CI 03. Release Please 04. Publish

Project

GitHub PyPI GitHub tag

Docs

Read the Docs

Meta

License Stars Forks Contributors

Standards

Python SemVer Keep a Changelog Release Please

pyipxact-de is a Python-based Design Environment and bindings for Accellera SPIRIT/IP-XACT. It targets SPIRIT v1.x and IP-XACT 1685-2009/2014/2022, enabling parsing, validation, transformation, and programmatic manipulation of IP-XACT artifacts (components, buses, designs, memory maps).

Key features:

  • Generated, schema-accurate models via xsData (initial version used PyXB ) under org.accellera.*

  • High-level APIs, CLI tools, and TGI helpers for common workflows (identify, validate, convert, , …).

  • Modern Python 3.14 tooling and type-annotated, docstring-rich codebase.

See the documentation for detailed guides, examples, and API references.

TODO

  • [ ] GUI and web front ends for interactive exploration.

Installation

Standard Installation

pip install pyipxact-de[cli,gui,web]

MCP Server Installation

The package includes an MCP (Model Context Protocol) server for IP-XACT validation that can be used with VS Code and other MCP-compatible clients.

Global Installation with uv

uv tool install pyipxact-de

Note: The package name on PyPI is pyipxact-de, but it provides the ipxact-de-mcp command.

Configuration for VS Code

Add the following to your VS Code MCP configuration (~/.config/Code/User/mcp.json):

{
  "servers": {
    "ipxact-de": {
      "command": "ipxact-de-mcp",
      "args": [],
      "env": {
        "PYTHONUNBUFFERED": "1"
      },
      "restart": "on-failure",
      "timeoutMs": 30000
    }
  }
}

Alternative MCP Installation

You can also install in your current environment:

# Using uv
uv add pyipxact-de

# Using pip
pip install pyipxact-de

Then reference the full path to the executable in your MCP configuration:

{
  "servers": {
    "ipxact-de": {
      "command": "/path/to/your/venv/bin/ipxact-de-mcp",
      "args": [],
      "cwd": "/path/to/your/project",
      "env": {
        "PYTHONUNBUFFERED": "1"
      },
      "restart": "on-failure",
      "timeoutMs": 30000
    }
  }
}

Available MCP Tools

The MCP server provides the following tools:

  • validate_xml: Validate IP-XACT XML files against Accellera schemas

Contributing

TODO

Project Structure

Python bindings for Accellera Spirit and Accellera versions are generated under org.accellera.* namespace.

src/
├── amal
│   ├── eda
│   │   └── ipxact_de
│   │       ├── cli
│   │       ├── gui
│   │       │   └── ui
│   │       │       └── icons
│   │       ├── tgi
│   │       │   └── ipxact
│   │       │       └── v1685_2022
│   │       └── web
│   └── utilities
└── org
    └── accellera
        ├── ipxact
        │   ├── v1685_2014
        │   └── v1685_2022
        │       ├── tgi
        │       └── ve
        ├── spirit
        │   ├── v1_0
        │   ├── v1_1
        │   ├── v1_2
        │   ├── v1_4
        │   │   └── tgi
        │   ├── v1_5
        │   │   └── tgi
        │   └── v1685_2009
        │       ├── tgi
        │       └── ve
        │           ├── ams
        │           ├── core
        │           ├── pdp
        │           └── power
        └── xsl