Skip to main content

No project description provided

Project description

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

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distributions

fast_xbrl_parser-0.1.0-cp310-none-win_amd64.whl (1.9 MB view hashes)

Uploaded CPython 3.10 Windows x86-64

fast_xbrl_parser-0.1.0-cp310-none-win32.whl (1.7 MB view hashes)

Uploaded CPython 3.10 Windows x86

fast_xbrl_parser-0.1.0-cp310-cp310-manylinux_2_24_x86_64.whl (3.2 MB view hashes)

Uploaded CPython 3.10 manylinux: glibc 2.24+ x86-64

fast_xbrl_parser-0.1.0-cp310-cp310-macosx_10_7_x86_64.whl (2.1 MB view hashes)

Uploaded CPython 3.10 macOS 10.7+ x86-64

fast_xbrl_parser-0.1.0-cp36-cp36m-macosx_10_7_x86_64.whl (2.1 MB view hashes)

Uploaded CPython 3.6m macOS 10.7+ x86-64

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page