Intro / Module Description

The xmlmicroparser Python Module provides basic XML Parser functionality without DTD / XSLT / SAX features.

Note

No “Document Type Definition”, “Extensible Stylesheet Language Transformation” or “Simple API for XML”, only plain XML parsing (recursive) supported.

1. System Install

pip3 install xmlmicroparser --break-system-packages

2. Virtual Env Install

Install into a python Virtual Environment is proposed.

# setup virtual-env
python3 -m venv .xml-microparser

# activate virtual-env
source .xml-microparser/bin/activate

# upgrade pip
python3 -m pip install --upgrade pip

# install xmlmicroparser module
pip3 install xmlmicroparser

# install dependencies
pip3 install pytest pytest-pep8

3. Build Dependencies

On current Debian 12 / Ubuntu 22.04.3, 24.04.1 install the following additional packages (Documentation Rendering & Testing).

# install base packages
apt-get install python3-pip python3-sphinx python3-sphinx-rtd-theme

# install pytest for running unit and integration tests
apt-get install python3-pytest python3-pytest-pep8

4. Tests

To run all tests (unit and integration) after pip package installation.

# run pytest
cd ./ && pytest

5. Current Features

  • Basic XML Parsing (recursive)

  • XML to JSON Transformation

  • Extendable Transformation Classes

6. Planned Features

  • Multiple Transformation Types (e.g. YAML)