xtce-lib 0.1.0a1__tar.gz

xtce_lib-0.1.0a1/.github/workflows/ci.yml

@@ -0,0 +1,62 @@
+name: CI/CD
+
+on:
+  push:
+    branches: ["main"]
+    tags: ["v*"]
+  pull_request:
+    branches: ["main"]
+
+jobs:
+  test:
+    name: Test on ${{ matrix.os }} / Python ${{ matrix.python-version }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+        python-version: ["3.11", "3.12", "3.13"]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v3
+        with:
+          enable-cache: true
+
+      - name: Set up Python ${{ matrix.python-version }}
+        run: uv python install ${{ matrix.python-version }}
+
+      - name: Install the project
+        run: uv sync --all-extras --dev
+
+      - name: Run tests
+        run: uv run pytest
+
+  publish:
+    name: Build and Publish to PyPI
+    needs: test
+    # Only run this if the tests pass and the push is a tag starting with 'v'
+    if: startsWith(github.ref, 'refs/tags/v')
+    runs-on: ubuntu-latest
+
+    # Required for PyPI trusted publishing
+    environment:
+      name: pypi
+      url: https://pypi.org/p/xtce-lib
+    permissions:
+      id-token: write
+      contents: read
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v3
+
+      - name: Build package
+        run: uv build
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

xtce_lib-0.1.0a1/.gitignore

@@ -0,0 +1,218 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#   Usually these files are written by a python script from a template
+#   before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+# Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+# uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+# poetry.lock
+# poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+# pdm.lock
+# pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+# pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#   JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#   be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#   and can be added to the global gitignore or merged into this file.  For a more nuclear
+#   option (not recommended) you can uncomment the following to ignore the entire idea folder.
+# .idea/
+
+# Abstra
+#   Abstra is an AI-powered process automation framework.
+#   Ignore directories containing user credentials, local state, and settings.
+#   Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#   Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore
+#   that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#   and can be added to the global gitignore or merged into this file. However, if you prefer,
+#   you could uncomment the following to ignore the entire vscode folder
+.vscode/
+# Temporary file for partial code execution
+tempCodeRunnerFile.py
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml

xtce_lib-0.1.0a1/.python-version

@@ -0,0 +1 @@
+3.11

xtce_lib-0.1.0a1/.xsdata.xml

@@ -0,0 +1,36 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Config xmlns="http://pypi.org/project/xsdata" version="26.2">
+  <Output maxLineLength="88" genericCollections="false">
+    <Package>generated</Package>
+    <Format repr="true" eq="true" order="false" unsafeHash="false" frozen="false" slots="false" kwOnly="true">dataclasses</Format>
+    <Structure>single-package</Structure>
+    <DocstringStyle>Google</DocstringStyle>
+    <RelativeImports>false</RelativeImports>
+    <CompoundFields defaultName="choice" useSubstitutionGroups="false" forceDefaultName="true" maxNameParts="3">true</CompoundFields>
+    <WrapperFields>false</WrapperFields>
+    <UnnestClasses>false</UnnestClasses>
+    <IgnorePatterns>false</IgnorePatterns>
+    <IncludeHeader>false</IncludeHeader>
+  </Output>
+  <Conventions>
+    <ClassName case="pascalCase" safePrefix="type"/>
+    <FieldName case="snakeCase" safePrefix="value"/>
+    <ConstantName case="screamingSnakeCase" safePrefix="value"/>
+    <ModuleName case="snakeCase" safePrefix="mod"/>
+    <PackageName case="snakeCase" safePrefix="pkg"/>
+  </Conventions>
+  <Substitutions>
+    <Substitution type="package" search="http://www.w3.org/2001/XMLSchema" replace="xs"/>
+    <Substitution type="package" search="http://www.w3.org/XML/1998/namespace" replace="xml"/>
+    <Substitution type="package" search="http://www.w3.org/2001/XMLSchema-instance" replace="xsi"/>
+    <Substitution type="package" search="http://www.w3.org/1998/Math/MathML" replace="mathml3"/>
+    <Substitution type="package" search="http://www.w3.org/1999/xlink" replace="xlink"/>
+    <Substitution type="package" search="http://www.w3.org/1999/xhtml" replace="xhtml"/>
+    <Substitution type="package" search="http://schemas.xmlsoap.org/wsdl/soap/" replace="soap"/>
+    <Substitution type="package" search="http://schemas.xmlsoap.org/wsdl/soap12/" replace="soap12"/>
+    <Substitution type="package" search="http://schemas.xmlsoap.org/soap/envelope/" replace="soapenv"/>
+    <Substitution type="package" search="http://schemas.xmlsoap.org/soap/encoding/" replace="soapenc"/>
+    <Substitution type="class" search="(.*)Class$" replace="\1Type"/>
+  </Substitutions>
+  <Extensions/>
+</Config>

xtce_lib-0.1.0a1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Nathan Miersen
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

xtce_lib-0.1.0a1/PKG-INFO

@@ -0,0 +1,153 @@
+Metadata-Version: 2.5
+Name: xtce-lib
+Version: 0.1.0a1
+Summary: Python tools for working with XTCE databases
+Author-email: Nathan Miersen <nrmiersen@gmail.com>
+License-File: LICENSE
+Requires-Python: >=3.11
+Requires-Dist: lxml>=6.1.0
+Requires-Dist: pydantic>=2.13.4
+Requires-Dist: xsdata>=26.2
+Description-Content-Type: text/markdown
+
+# xtce-lib
+
+[![Python](https://img.shields.io/badge/python-3.11%2B-blue.svg)](https://www.python.org/downloads/)
+[![License: MIT](https://img.shields.io/badge/license-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Development Status](https://img.shields.io/badge/status-alpha-orange.svg)](https://img.shields.io/badge/status-alpha-orange.svg)
+[![Code Style](https://img.shields.io/badge/code%20style-ruff-000000.svg)](https://github.com/astral-sh/ruff)
+[![Package Manager](https://img.shields.io/badge/package%20manager-uv-blueviolet.svg)](https://docs.astral.sh/uv/)
+
+`xtce-lib` provides Python tools for working with XTCE databases.
+
+It focuses on three pieces of functionality:
+
+- A unified, Pythonic XTCE model that flattens version-specific XML structure into a cleaner API.
+- XTCE file parsing and schema validation for XTCE 1.1, 1.2, and 1.3 documents.
+- XTCE path and registry helpers for resolving references inside a database.
+
+**Alpha software:** the API is not stable yet and may change in future releases.
+
+## Supported Versions
+
+`xtce-lib` currently supports XTCE versions [`1.1`](https://www.omg.org/spec/XTCE/1.1/), [`1.2`](https://www.omg.org/spec/XTCE/1.2/), and [`1.3`](https://www.omg.org/spec/XTCE/1.3/).
+
+## Installation
+
+From PyPI:
+```bash
+pip install xtce-lib
+```
+
+## Quick Start
+
+### Create an XTCE database
+
+```python
+from xtce_lib import XtceDatabase, xtce
+
+db = XtceDatabase(name="CONKSAT1")
+
+db.command_metadata = xtce.CommandMetadata(
+    argument_types=[
+        xtce.IntegerArgument(
+            name="uint32",
+            encoding_type=xtce.IntegerDataEncoding(
+                encoding=xtce.IntegerEncoding.UNSIGNED,
+                size_in_bits=32,
+            ),
+            signed=False,
+        ),
+        xtce.FloatArgument(
+            name="float32",
+            encoding_type=xtce.FloatDataEncoding(
+                encoding=xtce.FloatEncoding.IEEE754,
+                size_in_bits=32,
+            ),
+        ),
+    ],
+)
+```
+
+The database model removes XML-only intermediate nodes, so you can work with the model directly:
+
+```python
+for argument in db.command_metadata.argument_types:
+    print(argument.name)
+```
+
+After creating the database, writing to an XTCE document is as simple as:
+```python
+from pathlib import Path
+from xtce_lib import XtceFile, XtceVersion
+
+db.to_file(Path("CONKSAT1_XTCE.xml"), XtceVersion.V1_2)
+```
+
+### Parse an XTCE file
+
+```python
+from pathlib import Path
+from xtce_lib import XtceDatabase, XtceFile
+
+xtce_file = XtceFile(Path("CONKSAT1-XTCE.xml"))
+db: XtceDatabase = xtce_file.database
+```
+
+`XtceFile` can validate the XTCE against the XML schema and parse the XML into the unified `XtceDatabase` model.
+
+### Work with object paths
+
+```python
+>>> from xtce_lib import XtcePath
+>>> path = XtcePath("/CONKSAT1/BUS[2].BatteryVoltage")
+>>> root_path = XtcePath("/CONKSAT1")
+>>> path.relative_to(root_path)
+XtcePath('BUS[2].BatteryVoltage')
+>>> path.contains_array
+True
+>>> path.contains_aggregate
+True
+```
+
+`XtcePath` is a pathlib-like helper for XTCE hierarchies, including support for array and aggregate objects.
+
+## Development Roadmap
+- [x] Write a class to represent XTCE object paths (`XtcePath`)
+- [x] Generate Python representations of the XML schemas with `xsdata`
+- [x] Write a class to represent an XTCE file (`XtceFile`)
+- [x] Write a class to represent the unified XTCE model (`XtceDatabase`)
+- [x] Scaffold the structure of the unified XTCE model
+- [ ] Implement all base subclasses in the unified model, including translation methods
+  - [x] Algorithm models
+  - [x] Array models
+  - [x] Calibrator models
+  - [x] Common models
+  - [x] Condition models
+  - [x] Range models
+  - [x] Reference models
+  - [x] Stream models
+  - [x] Time models
+  - [x] Trigger models
+  - [x] Verifier models
+  - [x] Alarm models
+  - [x] Codec models
+  - [x] Datatype models
+  - [x] Argument models
+  - [x] Container models
+  - [x] Command models
+  - [x] Parameter models
+  - [ ] Telemetry models
+  - [ ] Space system
+  - [ ] Enum models
+- [x] Refactor translation methods for inherited classes
+- [ ] Implement unified model serialization and deserialization
+- [ ] Release alpha
+- [ ] Implement full model semantic validation
+- [ ] Write end-to-end tests for generating and parsing XTCE files
+- [ ] Write documentation
+  - [ ] Add examples to all applicable model Fields
+  - [ ] Automate API documentation generation
+
+## Disclaimer
+This project is an independent open-source implementation and is not affiliated with, endorsed by, or sponsored by the Object Management Group (OMG). XTCE is a specification developed by OMG. All trademarks are the property of their respective owners.

xtce_lib-0.1.0a1/README.md

@@ -0,0 +1,141 @@
+# xtce-lib
+
+[![Python](https://img.shields.io/badge/python-3.11%2B-blue.svg)](https://www.python.org/downloads/)
+[![License: MIT](https://img.shields.io/badge/license-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Development Status](https://img.shields.io/badge/status-alpha-orange.svg)](https://img.shields.io/badge/status-alpha-orange.svg)
+[![Code Style](https://img.shields.io/badge/code%20style-ruff-000000.svg)](https://github.com/astral-sh/ruff)
+[![Package Manager](https://img.shields.io/badge/package%20manager-uv-blueviolet.svg)](https://docs.astral.sh/uv/)
+
+`xtce-lib` provides Python tools for working with XTCE databases.
+
+It focuses on three pieces of functionality:
+
+- A unified, Pythonic XTCE model that flattens version-specific XML structure into a cleaner API.
+- XTCE file parsing and schema validation for XTCE 1.1, 1.2, and 1.3 documents.
+- XTCE path and registry helpers for resolving references inside a database.
+
+**Alpha software:** the API is not stable yet and may change in future releases.
+
+## Supported Versions
+
+`xtce-lib` currently supports XTCE versions [`1.1`](https://www.omg.org/spec/XTCE/1.1/), [`1.2`](https://www.omg.org/spec/XTCE/1.2/), and [`1.3`](https://www.omg.org/spec/XTCE/1.3/).
+
+## Installation
+
+From PyPI:
+```bash
+pip install xtce-lib
+```
+
+## Quick Start
+
+### Create an XTCE database
+
+```python
+from xtce_lib import XtceDatabase, xtce
+
+db = XtceDatabase(name="CONKSAT1")
+
+db.command_metadata = xtce.CommandMetadata(
+    argument_types=[
+        xtce.IntegerArgument(
+            name="uint32",
+            encoding_type=xtce.IntegerDataEncoding(
+                encoding=xtce.IntegerEncoding.UNSIGNED,
+                size_in_bits=32,
+            ),
+            signed=False,
+        ),
+        xtce.FloatArgument(
+            name="float32",
+            encoding_type=xtce.FloatDataEncoding(
+                encoding=xtce.FloatEncoding.IEEE754,
+                size_in_bits=32,
+            ),
+        ),
+    ],
+)
+```
+
+The database model removes XML-only intermediate nodes, so you can work with the model directly:
+
+```python
+for argument in db.command_metadata.argument_types:
+    print(argument.name)
+```
+
+After creating the database, writing to an XTCE document is as simple as:
+```python
+from pathlib import Path
+from xtce_lib import XtceFile, XtceVersion
+
+db.to_file(Path("CONKSAT1_XTCE.xml"), XtceVersion.V1_2)
+```
+
+### Parse an XTCE file
+
+```python
+from pathlib import Path
+from xtce_lib import XtceDatabase, XtceFile
+
+xtce_file = XtceFile(Path("CONKSAT1-XTCE.xml"))
+db: XtceDatabase = xtce_file.database
+```
+
+`XtceFile` can validate the XTCE against the XML schema and parse the XML into the unified `XtceDatabase` model.
+
+### Work with object paths
+
+```python
+>>> from xtce_lib import XtcePath
+>>> path = XtcePath("/CONKSAT1/BUS[2].BatteryVoltage")
+>>> root_path = XtcePath("/CONKSAT1")
+>>> path.relative_to(root_path)
+XtcePath('BUS[2].BatteryVoltage')
+>>> path.contains_array
+True
+>>> path.contains_aggregate
+True
+```
+
+`XtcePath` is a pathlib-like helper for XTCE hierarchies, including support for array and aggregate objects.
+
+## Development Roadmap
+- [x] Write a class to represent XTCE object paths (`XtcePath`)
+- [x] Generate Python representations of the XML schemas with `xsdata`
+- [x] Write a class to represent an XTCE file (`XtceFile`)
+- [x] Write a class to represent the unified XTCE model (`XtceDatabase`)
+- [x] Scaffold the structure of the unified XTCE model
+- [ ] Implement all base subclasses in the unified model, including translation methods
+  - [x] Algorithm models
+  - [x] Array models
+  - [x] Calibrator models
+  - [x] Common models
+  - [x] Condition models
+  - [x] Range models
+  - [x] Reference models
+  - [x] Stream models
+  - [x] Time models
+  - [x] Trigger models
+  - [x] Verifier models
+  - [x] Alarm models
+  - [x] Codec models
+  - [x] Datatype models
+  - [x] Argument models
+  - [x] Container models
+  - [x] Command models
+  - [x] Parameter models
+  - [ ] Telemetry models
+  - [ ] Space system
+  - [ ] Enum models
+- [x] Refactor translation methods for inherited classes
+- [ ] Implement unified model serialization and deserialization
+- [ ] Release alpha
+- [ ] Implement full model semantic validation
+- [ ] Write end-to-end tests for generating and parsing XTCE files
+- [ ] Write documentation
+  - [ ] Add examples to all applicable model Fields
+  - [ ] Automate API documentation generation
+
+## Disclaimer
+This project is an independent open-source implementation and is not affiliated with, endorsed by, or sponsored by the Object Management Group (OMG). XTCE is a specification developed by OMG. All trademarks are the property of their respective owners.

xtce_lib-0.1.0a1/pyproject.toml

@@ -0,0 +1,64 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "xtce-lib"
+version = "0.1.0a1"
+description = "Python tools for working with XTCE databases"
+readme = "README.md"
+authors = [{ name = "Nathan Miersen", email = "nrmiersen@gmail.com" }]
+requires-python = ">=3.11"
+dependencies = ["lxml>=6.1.0", "pydantic>=2.13.4", "xsdata>=26.2"]
+
+[dependency-groups]
+dev = [
+    "docformatter>=1.7.8",
+    "lxml-stubs>=0.5.1",
+    "pytest>=9.0.3",
+    "types-lxml>=2026.2.16",
+    "xsdata[cli]>=26.2",
+]
+
+[tool.docformatter]
+wrap-summaries = 88
+wrap-descriptions = 88
+close-quotes-on-newline = true
+blank = true
+exclude = ["generated", "xsd"]
+
+[tool.pyright]
+typeCheckingMode = "strict"
+reportMatchNotExhaustive = "error"
+reportPrivateUsage = false
+reportUnknownVariableType = false
+reportUnnecessaryIsInstance = false
+reportIncompatibleMethodOverride = false
+exclude = [
+    "**/.*",
+    ".venv",
+    "**/node_modules/**",
+    "**/__pycache__",
+    "**/generated/**",
+    "**/xsd/**",
+]
+
+[tool.ruff]
+line-length = 88
+exclude = ["**generated/**"]
+[tool.ruff.lint]
+select = [
+    "D", # pydocstyle
+    "I", # isort
+    "F", # pyflakes
+]
+ignore = [
+    "D203", # Conflicts with D211
+    "D205",
+    "D213", # Conflicts with D212
+]
+extend-select = ["D413"]
+[tool.ruff.lint.isort]
+known-first-party = ["xtce_lib"]
+[tool.ruff.lint.pydocstyle]
+convention = "google"