Metadata-Version: 2.1
Name: fast_xbrl_parser
Version: 0.2.0
Classifier: Programming Language :: Rust
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Requires-Python: >=3.6
Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM

<h1 align="center">
    Fast XBRL Parser
    <!-- 
   <img src="https://i.imgur.com/KZGIDj0.png" alt="Get started with Python for Research" title="Get started with Python for Research" />
   -->
</h1>
<p align="center">  
 <a href="https://mybinder.org/v2/gh/TiesdeKok/fast_xbrl_parser/master?urlpath=lab"><img src="https://mybinder.org/badge_logo.svg"></a>
 <a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/license-MIT-blue.svg"></a>
  <img src="https://img.shields.io/badge/last%20updated-December%202021-3d62d1">
 
</p>

<p align="center">
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. <br>
<strong>Warning - currently in development stages - use at your own risk</strong>
<br>
  <span style='font-size: 15pt'><strong>Author:</strong> Ties de Kok (<a href="https://www.TiesdeKok.com">Personal Page</a>)</span>
</p>

## Table of contents

  * [Introduction](#introduction)
  	* [Design philosophy](#philosophy)
  	* [Caveats](#caveats)
  * [How to use](#howtouse)
      * [Python](#python)
      * [Command line](#commandline)
  * [Questions?](#questions)
  * [License](#license)

<h2 id="introduction">Introduction</h2>
  

<h3 id="philosophy">Design philosophy</h3>

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)

<h3 id="caveats">Caveats</h3>

- 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. 

<h2 id="howtouse">How to use the parser</h2>

<h3 id="python">As a Python package</h3>

TBD

<h3 id="commandline">Standalone using the command line</h3>

TBD


<h2 id="questions">Questions?</h2>

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

<h2 id="license">License</h2>

[MIT](LICENSE) - Ties de Kok - 2022

