eba-xbridge


Nameeba-xbridge JSON
Version 1.0.4 PyPI version JSON
download
home_pagehttps://github.com/Meaningful-Data/xbridge
SummaryXBRL-XML to XBRL-CSV converter for EBA Taxonomy (version 3.4)
upload_time2024-11-27 13:02:23
maintainerNone
docs_urlNone
authorAntonio Olleros
requires_python<4.0,>=3.10
licenseApache 2.0
keywords xbrl eba taxonomy csv xml
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            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

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/Meaningful-Data/xbridge",
    "name": "eba-xbridge",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<4.0,>=3.10",
    "maintainer_email": null,
    "keywords": "xbrl, eba, taxonomy, csv, xml",
    "author": "Antonio Olleros",
    "author_email": "antonio.olleros@meaningfuldata.eu",
    "download_url": "https://files.pythonhosted.org/packages/a9/ca/bae11d3468046e31609df43487a4f1206958ddd658e0d40aef98b53d5811/eba_xbridge-1.0.4.tar.gz",
    "platform": null,
    "description": "Overview\n============\nXBridge is a Python library which main function is to convert XBRL-XML files into XBRL-CSV files by using EBA's taxonomy.\nIt works only with EBA Taxonomy upon version 3.4. Library must be updated on each new EBA taxonomy version.\n\nInstallation\n============\n\nTo install the library, run the following command:\n\n.. code:: bash\n\n    pip install eba-xbridge\n\n\nHow XBridge works:\n=========================\n\nFirstly, 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:\n\n.. code:: python\n\n  >>> from xbridge.api import convert_instance\n\n  >>> input_path = \"data/input\"\n\n  >>> output_path = \"data/output\"\n\n  >>> convert_instance(input_path, output_path)\n\nThe sources to do this process are two: The XML-instances and EBA\u00b4s taxonomy.\n\nThe output is the converted XBRL-CSV file placed in the output_path, as zip format\n",
    "bugtrack_url": null,
    "license": "Apache 2.0",
    "summary": "XBRL-XML to XBRL-CSV converter for EBA Taxonomy (version 3.4)",
    "version": "1.0.4",
    "project_urls": {
        "Homepage": "https://github.com/Meaningful-Data/xbridge",
        "Repository": "https://github.com/Meaningful-Data/xbridge"
    },
    "split_keywords": [
        "xbrl",
        " eba",
        " taxonomy",
        " csv",
        " xml"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "9d815409a78c3bff1926ec09099e976e6e8cea8ba89118d273092fb0f52f1855",
                "md5": "eb48311dfaeee27cb76bca08882fbd92",
                "sha256": "c5174d59838cbf72fdc832df436dfca379f269f0a550ce6fe10504980411adac"
            },
            "downloads": -1,
            "filename": "eba_xbridge-1.0.4-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "eb48311dfaeee27cb76bca08882fbd92",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4.0,>=3.10",
            "size": 1322673,
            "upload_time": "2024-11-27T13:02:21",
            "upload_time_iso_8601": "2024-11-27T13:02:21.658191Z",
            "url": "https://files.pythonhosted.org/packages/9d/81/5409a78c3bff1926ec09099e976e6e8cea8ba89118d273092fb0f52f1855/eba_xbridge-1.0.4-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "a9cabae11d3468046e31609df43487a4f1206958ddd658e0d40aef98b53d5811",
                "md5": "91c9b3372c9dd7a7ff8cc446c7ebdc13",
                "sha256": "7b578c38fa1d6a630c9b62841e4ef5bf0e4615c44df3fab693cbd6ff315437ff"
            },
            "downloads": -1,
            "filename": "eba_xbridge-1.0.4.tar.gz",
            "has_sig": false,
            "md5_digest": "91c9b3372c9dd7a7ff8cc446c7ebdc13",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4.0,>=3.10",
            "size": 1070640,
            "upload_time": "2024-11-27T13:02:23",
            "upload_time_iso_8601": "2024-11-27T13:02:23.403570Z",
            "url": "https://files.pythonhosted.org/packages/a9/ca/bae11d3468046e31609df43487a4f1206958ddd658e0d40aef98b53d5811/eba_xbridge-1.0.4.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-11-27 13:02:23",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "Meaningful-Data",
    "github_project": "xbridge",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "eba-xbridge"
}
        
Elapsed time: 0.38056s