eba-xbridge

Getting Started

  • Quickstart Guide
    • Prerequisites
    • Installation
    • Your First Conversion
      • Method 1: Command-Line Interface (Recommended for Quick Use)
      • Method 2: Python API (Recommended for Integration)
      • Step 3: Extract and Examine the Output
    • Common Use Cases
      • Use Case 1: Convert with Validation
      • Use Case 2: Handle Validation Warnings
      • Use Case 3: Inspect Instance Before Converting
      • Use Case 4: Batch Processing
      • Use Case 5: Custom Output Handling
    • Advanced Configuration
      • Headers as Datapoints
      • Error Handling
    • Next Steps
    • Troubleshooting
    • Getting Help
  • Frequently Asked Questions (FAQ)
    • General Questions
      • What is XBridge?
      • What taxonomy versions does XBridge support?
      • Is XBridge free and open source?
      • What Python versions are supported?
    • Installation & Setup
      • How do I install XBridge?
      • Why do I need the 7z command-line tool?
      • Can I use XBridge in a Docker container?
      • Can I use XBridge with virtual environments?
    • Usage Questions
      • How do I convert a simple XBRL-XML file?
      • What’s the difference between strict and non-strict validation?
      • What are orphaned facts?
      • How do I batch process multiple files?
      • Can I inspect an instance without converting it?
    • Output & Results
      • What format is the output?
      • How do I extract and read the output?
      • Can I customize the output format?
    • Performance Questions
      • How long does conversion take?
      • Can I speed up batch processing?
      • Why is taxonomy loading slow?
    • Error Messages & Troubleshooting
      • “FileNotFoundError: instance.xbrl not found”
      • “7z command not found”
      • “Orphaned facts detected”
      • “Module ‘xbridge’ has no attribute ‘convert_instance’”
      • “lxml.etree.XMLSyntaxError”
      • “MemoryError”
    • Development & Contributing
      • How can I contribute to XBridge?
      • How do I run the tests?
      • How do I report a bug?
      • Is there a roadmap for future features?
    • Taxonomy & Standards
      • What is XBRL?
      • What is the EBA taxonomy?
      • Does XBridge support other taxonomies?
      • What is DORA CSV?
      • When will XBridge support the next taxonomy version?
    • Licensing & Commercial Use
      • Can I use XBridge commercially?
      • Do I need to credit XBridge?
      • Can I get commercial support?
    • Still Have Questions?

User Guide

  • Technical notes
    • XML_instances
    • Conversion process
      • Workarounds
    • Load Taxonomy

API Reference

  • API Reference
    • Python API
    • Convert XBRL Instance to CSV
      • convert_instance()
    • Basic Usage
    • Advanced Usage Examples
      • Convert with Custom Options
      • Handle Validation Warnings
      • Batch Conversion
    • Parameters
      • load_instance()
    • Usage Examples
      • Basic Instance Loading
      • Inspect Instance Details
      • Validate Before Conversion
    • Parameters
    • Return Value
  • Command-Line Interface
    • Usage
    • Arguments
    • CLI Examples
  • Converter
    • Converter
      • Converter.convert()
      • Converter.convert_csv()
      • Converter.convert_xml()
    • Generating variables:
    • Converting tables:
    • Converting filing indicators:
    • Converting parameters:
  • Taxonomy loader
    • Taxonomy class
      • Taxonomy
        • Taxonomy.from_taxonomy()
        • Taxonomy.get_module()
        • Taxonomy.load_modules()
        • Taxonomy.modules
  • Modules
    • Module class
      • Module
        • Module.architecture
        • Module.dim_dom_file_name
        • Module.extract_tables()
        • Module.from_serialized()
        • Module.from_taxonomy()
        • Module.get_module_setup()
        • Module.get_table()
        • Module.is_relative_url()
        • Module.repeated_variables
        • Module.tables
        • Module.to_dict()
        • Module.variables_location
    • Table class
      • Table
        • Table.attributes
        • Table.check_taxonomy_architecture()
        • Table.extract_columns()
        • Table.extract_open_keys()
        • Table.extract_variables()
        • Table.filing_indicator_code
        • Table.from_dict()
        • Table.from_taxonomy()
        • Table.generate_variable_df()
        • Table.get_table_code()
        • Table.open_keys
        • Table.to_dict()
        • Table.variable_columns
        • Table.variable_df
        • Table.variables
    • Variable class
      • Variable
        • Variable.dimensions
        • Variable.extract_allowed_values()
        • Variable.extract_dimensions()
        • Variable.from_dict()
        • Variable.from_taxonomy()
        • Variable.to_dict()
  • XML Instance
    • Instance Class
    • Scenario Class
    • Context Class
    • Fact Class
    • Filing Indicator Class

Additional Resources

  • GitHub Repository
  • Issue Tracker
  • Changelog
  • Contributing
  • Security Policy
eba-xbridge
  • Search

© Copyright 2025 MeaningfulData.

Built with Sphinx using a theme provided by Read the Docs.