---
id: xknxproject
version: "3.10.0"
license: GPL-2.0-only
license_treatment: copyleft
maintenance: active
---

# xknxproject — A library to gather information from ETS project files used for KNX

License: copyleft · Maintenance: active · Downloads: 107.8K/mo

## What it is and what it does

xknxproject is a library for extracting and parsing KNX project files—the configuration archives used by the ETS (Engineering Tool Software) to define building automation systems. It reads password-protected project files from ETS 4, 5, and 6 and exposes the underlying XML structure as typed Python objects, making it easy to programmatically access device addresses, group addresses, communication objects, DPT types, room assignments, and function mappings.

The library is designed for developers who need to integrate KNX project data into other tools or systems—particularly Home Assistant integrations and custom automation workflows. It depends on pyzipper for archive handling and striprtf for text extraction, and returns results as a typed dictionary that can be serialized to JSON. Parse times are typically 1.5 seconds for medium projects and longer for larger configurations.

Use it for:

- Extract device and group address mappings from an ETS project to populate a Home Assistant KNX integration
- Parse communication object definitions and DPT types to validate a KNX system configuration programmatically
- Read room and location metadata from a project file to generate documentation or a device inventory
- Automate migration of KNX project data into a custom building management system
- Analyze device channels and their GA assignments to debug or audit a KNX installation

## Worth the install?

AI-flagged interpretation of the facts above — verify before relying.

Extracts and parses KNX project files (ETS 4, 5, and 6 formats, including password-protected archives) to read device addresses, group addresses, communication objects, and location metadata as structured data.

Yes, if you need to read KNX project files programmatically and accept the GPL-2.0 copyleft constraint. The library is actively maintained, has low install friction, and solves a specific problem with no known vulnerabilities. Not suitable for proprietary or closed-source projects due to its license.

## Install

pip install xknxproject
uv add xknxproject
poetry add xknxproject

## Installing xknxproject

Before you install: Low friction install with only two runtime dependencies (pyzipper, striprtf). Actively maintained with a recent release (12 days old) and steady repository activity.

License in practice: GPL-2.0-only copyleft license means any code that links this library must also be released under GPL-2.0 or compatible terms; proprietary or closed-source projects cannot use it.

Quickstart:

from xknxproject import XKNXProj
from xknxproject.models import KNXProject

knxproj = XKNXProj(
    path="file.knxproj",
    password="optional_password",
    language="de-DE"
)
project: KNXProject = knxproj.parse()

Requires Python >=3.9.0; loading a middle-sized project takes about 1.5 seconds, larger projects may take >3 seconds.

Verify before relying:

- Performance characteristics for very large projects beyond the mentioned >3s threshold
- Which ETS 4, 5, and 6 project features are fully supported versus partially supported or excluded
- Language fallback behavior when configured language is unavailable

## Package facts

- License: GPL-2.0-only (copyleft)
- Python support: supports_current
- Install friction: low
- Maintenance: active
- Downloads: 107.8K/month (top 15,000 on PyPI)
- Known vulnerabilities: none known

## Tags

KNX project file parser, ETS project extraction, KNX device address reader, home automation configuration parser, KNX group address extractor, knx-automation, home-assistant, configuration-parser

[View on SkillFed](https://skillfed.io/packages/xknxproject) · [View on PyPI](https://pypi.org/project/xknxproject/)