Metadata-Version: 2.1
Name: eba-xbridge
Version: 0.11
Summary: XBRL-XML to XBRL-CSV converter for EBA Taxonomy (version 3.4)
Home-page: 
Author: Antonio Olleros, Jesus Simon, Javier Hernandez
Author-email: antonio.olleros@meaningfuldata.eu, jesus.simon@meaningfuldata.eu, javier.hernandez@meaningfuldata.eu
License: Apache 2.0
Project-URL: Bug Tracker, https://github.com/Meaningful-Data/xbridge/issues
Project-URL: Documentation, https://docs.xbridge.meaningfuldata.eu
Project-URL: Source Code, https://github.com/Meaningful-Data/xbridge
Classifier: Programming Language :: Python :: 3
Description-Content-Type: text/x-rst
Requires-Dist: pandas==2.2.2
Requires-Dist: lxml==5.2.2
Requires-Dist: py7zr==0.21.0

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
