All Projects → manusimidt → py-xbrl

manusimidt / py-xbrl

Licence: GPL-3.0 license
Python-based parser for parsing XBRL and iXBRL files

Programming Languages

python
139335 projects - #7 most used programming language
HTML
75241 projects

Projects that are alternatives of or similar to py-xbrl

Xoxo
reading, writing and comparing XBRL reports
Stars: ✭ 19 (-59.57%)
Mutual labels:  xbrl, ixbrl
edgarWebR
R package for interacting with the SEC's EDGAR filing search and retrieval system
Stars: ✭ 63 (+34.04%)
Mutual labels:  xbrl, edgar
gepsio
Gepsio is a document object model for XBRL documents based on .NET 6.
Stars: ✭ 50 (+6.38%)
Mutual labels:  xbrl, xbrl-parser
edgar-crawler
Download financial reports from SEC's EDGAR. Extract clean textual data from specific item sections and bootstrap your financial NLP research. Software from the research paper published in ECONLP 2021.
Stars: ✭ 71 (+51.06%)
Mutual labels:  edgar
python api client
A Python client for Calcbench's API.
Stars: ✭ 16 (-65.96%)
Mutual labels:  xbrl
XBRL
Classes that implement the XBRL 2.1, XDT, Formulas, Generics, XFI and other XBRL specifications
Stars: ✭ 29 (-38.3%)
Mutual labels:  xbrl
SEC-EDGAR-text
Text information from US companies' SEC EDGAR electronic filings
Stars: ✭ 75 (+59.57%)
Mutual labels:  edgar

XBRL-Parser

PyPI PyPI - Status PyPI - Python Version GitHub PyPI - Downloads GitHub code size in bytes Documentation Status

XBRL-Parser

Py-xbrl is a python library that allows the user to easily parse XBRL-Documents. Py-xbrl is primarily build to parse Instance Documents (originally from the SEC) but can also be used to parse any type of XBRL Document as long as it follows the XBRL 2.1 Specification (2003)1 or the iXBRL 1.1 Specification(2013)2.

XBRL is a very information-rich markup language that can have highly complex structures. This library tries to capture as much of the original information as possible. Py-xbrl will automatically download and parse all referenced XBRL-Files like taxonomy schemas and linkbases. After parsing py-xbrl will organize all information in an object structure and return it to the user.

Please read the documentation for more information and examples!: https://py-xbrl.readthedocs.io

Installation

Py-xbrl can be installed via PIP:

pip install py-xbrl

see the documentation for more info.

Questions

If you have questions regarding the library please post them into the GitHub discussion forum.

Contributing

I am always happy to receive contributions. You can either work on an already created issue or create a new pull request. You can also create a pull request if you want to propose a change to the documentation on readthedocs.io. Please keep in mind that the goal of this library is to parse XBRL files correctly. Therefore, it is important that the unit tests work on any pull request. Additionally, py-xbrl should still be able to parse all xbrl files correctly. It is best to create a discussion in the GitHub discussion board before creating the pull request to avoid that a lot of work is done, but the pull request is not merged in the end.

Footnotes

  1. https://www.xbrl.org/Specification/XBRL-2.1/REC-2003-12-31/XBRL-2.1-REC-2003-12-31+corrected-errata-2013-02-20.html

  2. https://www.xbrl.org/specification/inlinexbrl-part1/rec-2013-11-18/inlinexbrl-part1-rec-2013-11-18.html

Note that the project description data, including the texts, logos, images, and/or trademarks, for each open source project belongs to its rightful owner. If you wish to add or remove any projects, please contact us at [email protected].