Metadata-Version: 2.1
Name: eba-xbridge
Version: 1.0.2
Summary: XBRL-XML to XBRL-CSV converter for EBA Taxonomy (version 3.4)
Home-page: https://github.com/Meaningful-Data/xbridge
License: Apache 2.0
Keywords: xbrl,eba,taxonomy,csv,xml
Author: Antonio Olleros
Author-email: antonio.olleros@meaningfuldata.eu
Requires-Python: >=3.10,<4.0
Classifier: License :: Other/Proprietary License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Dist: lxml (>=5.2.1,<6.0.0)
Requires-Dist: pandas (>=2.1.4,<3.0.0)
Project-URL: Repository, https://github.com/Meaningful-Data/xbridge
Description-Content-Type: text/x-rst

Overview
============
XBridge is a Python library which main function is to convert XBRL-XML files into XBRL-CSV files by using EBA's taxonomy.
It works only with EBA Taxonomy upon version 3.4. Library must be updated on each new EBA taxonomy version.

Installation
============

To install the library, run the following command:

.. code:: bash

    pip install eba-xbridge


How XBridge works:
=========================

Firstly, an XBRL-XML file has to be selected to convert it. Then, that XBRL-XML file is input in the following function contained in the ``API`` package:

.. code:: python

  >>> from xbridge.api import convert_instance

  >>> input_path = "data/input"

  >>> output_path = "data/output"

  >>> convert_instance(input_path, output_path)

The sources to do this process are two: The XML-instances and EBA´s taxonomy.

The output is the converted XBRL-CSV file placed in the output_path, as zip format

