fast-xbrl-parser 0.1.0

No project description provided

Fast XBRL Parser

An XBRL parser built in Rust that provides a fast, easy, and lightweight way to convert XBRL XML files into JSON or CSV. Available as a Python library or a standalone command line utility.
Warning - currently in development stages - use at your own risk
Author: Ties de Kok (Personal Page)

Table of contents

• Introduction
  • Design philosophy
  • Caveats
• How to use
  • Python
  • Command line
• Questions?
• License

Introduction

Design philosophy

The objective of fast-xbrl-parser is to provide a fast, easy, and lightweight way to parse XBRL XML files into JSON or CSV. It is built with the following objectives in mind:

• Easy to use API
• Very fast
• Lightweight and easy to install
• Cross-platform support (Windows, Linux, and Mac OS are supported)

Caveats

• Only tested on US XBRL files from SEC EDGAR
• Opinionated conversion to CSV
• Not validated against the XBRL specification

Use at your own discretetion and always verify the results yourself.

How to use the parser

As a Python package

TBD

Standalone using the command line

TBD

Questions?

If you have questions or experience problems please use the issues tab of this repository.

License

MIT - Ties de Kok - 2022