## XBRL-Parser
[](https://pypi.org/project/py-xbrl/#history)
[](https://pypi.org/project/py-xbrl/)
[](https://pypi.org/project/py-xbrl/)
[](https://github.com/manusimidt/xbrl_parser/blob/main/LICENSE)
[](https://pypi.org/project/py-xbrl/)
[](https://github.com/m4nu3l99/xbrl_parser)
[](https://py-xbrl.readthedocs.io/en/latest/?badge=latest)
## 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
[^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
## Installation
Py-xbrl can be installed via PIP:
```shell
pip install py-xbrl
```
see the [documentation](https://py-xbrl.readthedocs.io/en/latest/) for more info.
## Questions
If you have questions regarding the library please post them into
the [GitHub discussion forum](https://github.com/manusimidt/py-xbrl/discussions).
## 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.
Raw data
{
"_id": null,
"home_page": "https://github.com/manusimidt/xbrl_parser",
"name": "py-xbrl",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": "Manuel Schmidt",
"author_email": "hello@schmidt-manuel.de",
"download_url": "https://files.pythonhosted.org/packages/ea/87/e6ede44460655a75966fa75d68177791a53159d137390ccf83c3ac8167eb/py_xbrl-2.2.12.tar.gz",
"platform": null,
"description": "## XBRL-Parser\r\n\r\n\r\n[](https://pypi.org/project/py-xbrl/#history)\r\n[](https://pypi.org/project/py-xbrl/)\r\n[](https://pypi.org/project/py-xbrl/)\r\n[](https://github.com/manusimidt/xbrl_parser/blob/main/LICENSE)\r\n[](https://pypi.org/project/py-xbrl/)\r\n[](https://github.com/m4nu3l99/xbrl_parser)\r\n[](https://py-xbrl.readthedocs.io/en/latest/?badge=latest)\r\n \r\n\r\n## XBRL-Parser\r\n\r\nPy-xbrl is a python library that allows the user to easily parse XBRL-Documents. Py-xbrl is primarily build \r\nto parse Instance Documents (originally from the SEC) but can also be used to parse any type of XBRL \r\nDocument as long as it follows the XBRL 2.1 Specification (2003)[^1] or the iXBRL 1.1 Specification(2013)[^2].\r\n\r\nXBRL is a very information-rich markup language that can have highly complex structures. This library tries to capture\r\nas much of the original information as possible. Py-xbrl will automatically download and parse all referenced XBRL-Files\r\nlike taxonomy schemas and linkbases. After parsing py-xbrl will organize all information in an object structure and \r\nreturn it to the user.\r\n\r\nPlease read the documentation for more information and examples!:\r\nhttps://py-xbrl.readthedocs.io\r\n\r\n[^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\r\n[^2]: https://www.xbrl.org/specification/inlinexbrl-part1/rec-2013-11-18/inlinexbrl-part1-rec-2013-11-18.html\r\n\r\n## Installation\r\nPy-xbrl can be installed via PIP:\r\n```shell\r\npip install py-xbrl\r\n```\r\nsee the [documentation](https://py-xbrl.readthedocs.io/en/latest/) for more info.\r\n\r\n## Questions\r\nIf you have questions regarding the library please post them into\r\nthe [GitHub discussion forum](https://github.com/manusimidt/py-xbrl/discussions).\r\n\r\n## Contributing\r\nI am always happy to receive contributions. You can either work on \r\nan already created issue or create a new pull request. You can also create a pull request\r\nif you want to propose a change to the documentation on readthedocs.io. \r\nPlease keep in mind that the goal of this library is to parse XBRL files correctly. Therefore, it is important\r\nthat the unit tests work on any pull request. Additionally, py-xbrl should still be able to parse all \r\nxbrl files correctly. It is best to create a discussion in the GitHub discussion board before creating the pull request \r\nto avoid that a lot of work is done, but the pull request is not merged in the end. \r\n",
"bugtrack_url": null,
"license": "GNU General Public License v3 (GPLv3)",
"summary": "Parser for parsing XBRL and iXBRL files (instance documents, taxonomy schemas, taxonomy linkbases).",
"version": "2.2.12",
"project_urls": {
"Homepage": "https://github.com/manusimidt/xbrl_parser"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "580cc6b39edc6d020de4bfbf5ded0184f154c27e3501209e0b4e989ecde344d1",
"md5": "e9a4b413036dae117abb95ac235a2982",
"sha256": "7e04058924999fce4fd91d14810a9831fb740239e614c418ce586a8a9a8621d3"
},
"downloads": -1,
"filename": "py_xbrl-2.2.12-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e9a4b413036dae117abb95ac235a2982",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 53478,
"upload_time": "2024-07-06T10:29:26",
"upload_time_iso_8601": "2024-07-06T10:29:26.469465Z",
"url": "https://files.pythonhosted.org/packages/58/0c/c6b39edc6d020de4bfbf5ded0184f154c27e3501209e0b4e989ecde344d1/py_xbrl-2.2.12-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ea87e6ede44460655a75966fa75d68177791a53159d137390ccf83c3ac8167eb",
"md5": "b47fd0f24a34b03f8f98fc510ce03951",
"sha256": "97c2171578323f11f8b3de44f87079722261490a33e527948215bb960e189cfd"
},
"downloads": -1,
"filename": "py_xbrl-2.2.12.tar.gz",
"has_sig": false,
"md5_digest": "b47fd0f24a34b03f8f98fc510ce03951",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 57128,
"upload_time": "2024-07-06T10:29:28",
"upload_time_iso_8601": "2024-07-06T10:29:28.313166Z",
"url": "https://files.pythonhosted.org/packages/ea/87/e6ede44460655a75966fa75d68177791a53159d137390ccf83c3ac8167eb/py_xbrl-2.2.12.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-06 10:29:28",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "manusimidt",
"github_project": "xbrl_parser",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "setuptools",
"specs": [
[
"==",
"70.2.0"
]
]
},
{
"name": "requests",
"specs": [
[
"~=",
"2.32.3"
]
]
},
{
"name": "urllib3",
"specs": [
[
"~=",
"2.2.2"
]
]
}
],
"tox": true,
"lcname": "py-xbrl"
}
JSON
