ocpiupdate 0.4.1

An updater for OpenCPI Projects

ocpiupdate - An updater for OpenCPI projects

ocpiupdate updates OpenCPI Projects to use style associated with newer versions of OpenCPI.

For example:

• Using <worker>-<model>.xml for the Worker Description files, instead of <worker>.xml.
• Using <component>.comp/<component>-comp.xml for Component Specification files instead of specs/<component>[-_]spec.xml.
• Using xml files instead of Makefiles.

Dependencies

This library requires Python 3.11 or newer. This means it doesn't support the default system python3 install on Ubuntu 20.04 or Ubuntu 22.04.

If you use a system with Python 3.10 or older, you need to either:

• Install a newer python3 just for this library.
  • I'd recommend using a tool like uv.
• Download and run the containerised version.

Installation

pip

You can install the latest release from PyPi:

pip install ocpiupdate

Or, you can install this repository directly:

# Installs `develop` branch
pip install git+https://gitlab.com/dawalters/ocpiupdate

# Installs `v0.4.1` branch
pip install git+https://gitlab.com/dawalters/ocpiupdate@v0.4.1

Issues on Ubuntu 20.04 and 22.04

Ubuntu 20.04 and 22.04 experience segfaults when using the pre-compiled wheels for tree-sitter-make that download from PyPi.

This problem is avoidable by instructing pip to install tree-sitter-make from source. Unfortunately the source is missing some required include files. This is fixable by coping the headers locally before installing:

git clone https://github.com/Freed-Wu/tree-sitter-make /tmp/tree-sitter-make
cp -rf /tmp/tree-sitter-make/src/tree_sitter /usr/local/include/.

# For `pip` when installing just `ocpiupdate
pip3 install --no-binary tree-sitter-make ocpiupdate

# Or for `uv` when developing for `ocpiupdate`
uv sync --no-binary-package tree-sitter-make

Note: these headers are specific to tree-sitter-make and could cause conflicts when building other tree sitter bindings.

docker or podman

The containers directory contains a variety of containers, relying only on a local installation of docker or podman.

You can download built containers from the Gitlab Container Registry. This will happen automatically when a registry image is run:

project_directory=/path/to/project/root

container_name=registry.gitlab.com/dawalters/ocpiupdate:v0.4.1

additional_arguments="--dry-run --verbose"

# for `podman`, just replace `docker`
docker run \
    --volume "$project_directory":"$project_directory" \
    --workdir "$project_directory" \
    "$container_name" \
    "$additional_arguments"

See containers/scripts/ocpiupdate.sh for a more complex example.

Source tarball

You can download source releases from the Gitlab Releases page.

Configuration

Until documentation becomes available, you can follow the release posts available on the OpenCPI forum.

This includes examples of usage, and discussion of how to write configuration files.

Disclaimer

This repository has no affiliation with OpenCPI.

The maintainer doesn't maintain OpenCPI.