{"repo":"kanedata/ixbrl-parse","free":true,"listed":false,"github":"https://github.com/kanedata/ixbrl-parse","clone":"git clone https://github.com/kanedata/ixbrl-parse.git","description":"A python library for getting useful data out of ixbrl files.","language":"HTML","stars":71,"topics":["finance","python","python37","xbrl"],"license":"MIT","category":"trading","readme_excerpt":"ixbrl-parse A lightweight python module for getting useful data out of iXBRL™ and XBRL™ files. The library is at an early stage - feedback and improvements are very welcome. Full documentation is available at ixbrl-parse.readthedocs.io For more about the iXBRL™ and XBRL™ standards, see the specification site and XBRL International. This tool is not affiliated with XBRL International. Changelog Quickstart If you use uv you can run the tool against an iXBRL™ file without installing it by running: This will output a CSV file containing items from the account. Requirements The module requires BeautifulSoup and lxml to parse the documents. If you're using Python 3.13 you may need to ensure that the libxml2-dev and libxslt-dev packages have been installed. word2number is used to process the numeric items with the numsenwords format. How to install You can install from pypi using pip: How to use You can run the module directly to extract data from an iXBRL™ file. While primarily designed for iXBRL™ files, the parser should also work for XBRL™ files. The various options for using this can be found through: You can also use as a python module (see the documentation for more details) Development The module is setup for development using hatch. It should be possible to run tests and linting without needed hatch, however. Run tests Tests can be run with pytest : Without hatch, you'll need to run: Test coverage Run tests then report on coverage Without hatch, you'll need to run: Run tests","default_branch":null,"files":null,"tree":[],"storefront":"/r/kanedata","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/kanedata/ixbrl-parse/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}