Skip to content

BUILD.md

Latest commit

 

History

History
84 lines (54 loc) · 2.34 KB

BUILD.md

File metadata and controls

84 lines (54 loc) · 2.34 KB
Raw

Building the eIQ AAF Connector Debian Package

This document provides detailed instructions for building the Debian package for the eIQ AAF Connector project.

Prerequisites

System Requirements

  • Operating System: Ubuntu/Debian-based Linux distribution
  • Network: Internet connection for downloading dependencies

Required Tools

  • git - for repository management and submodule handling
  • dpkg-dev - Debian package development tools
  • debhelper - helper programs for debian/rules
  • dh-python - Debian packaging tools for Python
  • python3 (>= 3.13) - Python interpreter
  • uv - Modern Python package and project manager

Quick Build

For a quick build using the provided automation, follow these steps:

# 1. Clone the repository
git clone <repository-url>
cd eiq-aaf-connector

# 2. Configure build environment (install dependencies)
make configure

# 3. Build the Debian package
make build

# 4. Check the built packages
make install

The built packages will be available in the build/deb/ directory.

Build Artifacts

After a successful build, you'll find the following artifacts in build/deb/:

  • eiq-aaf-connector_<version>_all.deb - The main Debian package
  • eiq-aaf-connector_<version>.dsc - Source package description
  • eiq-aaf-connector_<version>.tar.xz - Source package archive
  • eiq-aaf-connector_<version>_amd64.changes - Changes file for package management

Package Contents

The built Debian package includes:

Installed Files

  • Python Wheel: /usr/share/python-wheels/eiq_aaf_connector-<version>-py3-none-any.whl
  • Configuration: /usr/share/eiq/aaf-connector/server_config.json

Dependencies

  • python3 - Python 3 interpreter
  • python3-pip - Python package installer
  • rt-sdk-ara2 - ARA Runtime SDK for ARA240
  • Standard Python 3 dependencies (automatically resolved)

Installation

After building, install the package:

dpkg -i build/deb/eiq-aaf-connector_<version>_all.deb

Configuration

The configuration process should be done on the postinst script. Please review it for detail.

Related Documentation