Skip to main content

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.

  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

Release files for py-xbrl 3.0.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for py-xbrl 3.0.3
File Size Uploaded
py_xbrl-3.0.3.tar.gz 59.4 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for py-xbrl 3.0.3
File Interpreter ABI Platform
py_xbrl-3.0.3-py3-none-any.whl Python 3 none any Details

Total release size: 115.8 kB

Release files / py_xbrl-3.0.3.tar.gz

Download URL py_xbrl-3.0.3.tar.gz
Size 59.4 kB
Tags Source
SHA-256 checksum
How to use checksums
fe599a49b15cb8bfcb8b60c04a59934e4757f3fc59fd1b09357afb1574335074
BLAKE2b-256 checksum
How to use checksums
4482423a91bbf7fdd7471c497d67223c0135f97b03c5ae9a2ddec254187a3f8f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.12.12

Release files / py_xbrl-3.0.3-py3-none-any.whl

Download URL py_xbrl-3.0.3-py3-none-any.whl
Size 56.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
6eddaf493f9c012bbe4b28b0e1d19891a367cf45a3e8af859ceb579169120392
BLAKE2b-256 checksum
How to use checksums
d1686a8b0d17cfda1430780cd2a03b47509fef31f688f532c642ea09e6a8eac6
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.12.12

Release history Release notifications | RSS feed

This release

3.0.3 This release

2 release files

3.0.2

2 release files

3.0.1

2 release files

3.0.0

2 release files

2.2.17

2 release files

2.2.16

2 release files

2.2.15

2 release files

2.2.14

2 release files

2.2.11

2 release files

2.2.10

2 release files

2.2.9

2 release files

2.2.8

2 release files

2.2.7

2 release files

2.2.6

2 release files

2.2.5

2 release files

2.2.4

2 release files

2.2.3

2 release files

2.2.2

1 release file

2.2.1

2 release files

2.2.0

2 release files

2.1.1

2 release files

2.1.0

2 release files

2.0.7

2 release files

2.0.6

2 release files

2.0.5

2 release files

2.0.4

2 release files

2.0.3

2 release files

2.0.2

2 release files

2.0.1

2 release files

2.0.0

2 release files

1.2.1

2 release files

1.2.0

2 release files

1.1.4

2 release files

1.1.3

2 release files

1.1.2

2 release files

1.1.1

2 release files

1.1.0

2 release files

1.0.0

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page