xknxproject
A library to gather information from ETS project files used for KNX
Decision gist · record as of 2026-08-14
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.AI-flagged interpretation of the facts on this page — verify before relying
Before you install
- Requires Python >=3.9.0; loading a middle-sized project takes about 1.5 seconds, larger projects may take >3 seconds.
- Low friction install with only two runtime dependencies (pyzipper, striprtf).
- Actively maintained with a recent release (12 days old) and steady repository activity.
License · maintenance · safety
GPL-2.0-only (copyleft) — 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.
last release 2026-08-02 (12 days) · last repo commit 2026-08-02 · 117 stars
0 known vulnerabilities (OSV.dev, 2026-08-14) · 107,787 downloads/mo, #12,595 on PyPI
Alternatives
Verify before relying
from xknxproject import XKNXProj
from xknxproject.models import KNXProject
knxproj = XKNXProj(
path="file.knxproj",
password="optional_password",
language="de-DE"
)
project: KNXProject = knxproj.parse()- 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
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 on this page. Verify before relying on it.
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
xknxproject on PyPI
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.
Requires Python >=3.9.0; loading a middle-sized project takes about 1.5 seconds, larger projects may take >3 seconds.
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()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 the current Python release >=3.9.0 |
| Install friction | Low. Pure-Python wheel |
| Runtime dependencies | 2 packagespyzipperstriprtf |
| Maintenance | Actively maintained 12 days since the last release |
| Last repo commit | |
| First released | |
| Downloads | 107,787 / month, #12,595 on PyPI 30-day window, as of 2026-08-14 |
| Known vulnerabilities | None known OSV.dev, checked 2026-08-14 |
| Classifiers | Development Status :: 4 - BetaIntended Audience :: DevelopersProgramming Language :: Python :: 3 |
Evidence: xknxproject-3.10.0-py3-none-any.whl
Tags
Let your AI agent find packages like this
Example. Real query, live index.
You found this page by searching. An agent finds it by wishing: SkillFed indexes 14,416 PyPI packages by what they can do, searchable in plain language.
wish › “KNX project file parser”
- xknxprojectExtracts and parses KNX project files (ETS 4, 5, and 6 formats,…
- xknxXKNX is an asynchronous Python library for communicating with KNX…
- knx-frontendProvides a web-based user interface panel for the KNX integration in…
Give your agent the search over MCP, or paste the wish link into any chat.
More Utilities packages
Converts domain names between Unicode and ASCII-compatible encoding (Punycode) according to IDNA 2008 and Unicode Technical Standard 46, with security validation and broader script coverage than the standard library.
Install it if you work with internationalized domain names, need to validate domains, or use HTTP clients that depend on it transitively.
Detects and normalizes text encoding from unknown or ambiguous sources, supporting all IANA character sets that Python's core library provides codecs for, with the ability to register custom codecs.
Setuptools is a Python build backend and package management tool that handles building, distributing, and installing Python packages, including support for C/C++ extension modules.
Pluggy provides a plugin system that lets you define hook specifications and register implementations to be called in sequence, enabling extensible Python applications without tight coupling.
Install it if you're building an extensible application or framework.
Pygments is a syntax highlighter that colorizes source code and text in over 500 languages and formats, outputting to HTML, LaTeX, RTF, SVG, images, or ANSI terminal sequences.
Install it if you need to display or transform source code.
Six provides utility functions to write Python code that runs on both Python 2.7 and Python 3.3+, smoothing over language differences between the two versions.
See also xknx · knx-frontend · textract · pyap · extractcode · usaddress · pyap2 · ipsw-parser · petl · mailbits