py-sec-xbrl
SEC EDGAR Parser based on Python 3
Intruduction
This is a tool intended to parse XBRL files from SEC. Thus, the focus is to parse XBRL XML files so that data is more easily accessible. The idea is to provide a tool for you to code you want instead of a tool that implements a workflow but is rigid.
In addition, it's not intended to be a tool to scrap SEC EDGAR as it varies a lot as to how you want to do the scrapping and it's relatively easier. (though it can be added later if you want)
The repository is originally forked from https://github.com/tooksoi/ScraXBRL, but I soon find out that we have very different approaches and objectives, so soon afterwards the code in the 2 repositories are completely different and nothing is taken from ScraXBRL.
How to install
Current verion: v0.1
Dependencies: in the requirements.txt file, currently only the lxml library
Installation:
pip install py-sec-xbrl
How to start
- get some XBRL XML files (see documentation if you don't have one yet)
- see
test-parse.py, modify the path to the XML file and it's really easy
Documentation
More detailed documentation can be found here: doc
Development roadmap
2 priorities for the moment:
- Basic SEC XBRL parsing capabilities
- Make the scripts ready as a library that can be installed
Metadata
Release files for py-sec-xbrl 0.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| py-sec-xbrl-0.2.tar.gz | 12.1 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| py_sec_xbrl-0.2-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 25.6 kB
Release files / py-sec-xbrl-0.2.tar.gz
| Download URL | py-sec-xbrl-0.2.tar.gz |
|---|---|
| Size | 12.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
192efb9a81a18866b1bd2f83eabd30f7c6891820fbca930225c61a5f42b38ea8
|
|
BLAKE2b-256 checksum How to use checksums |
c9851a65f6cb55ac7d7f4466e2ae19546f26fa11c0f723c79ce65226a72ff2f7
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/46.1.3 requests-toolbelt/0.9.1 tqdm/4.42.1 CPython/3.7.6
|
Release files / py_sec_xbrl-0.2-py3-none-any.whl
| Download URL | py_sec_xbrl-0.2-py3-none-any.whl |
|---|---|
| Size | 13.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
b2586bb77cfedf610d41512a7c66ef03f463eec13d27789ad273b86ad55bca5c
|
|
BLAKE2b-256 checksum How to use checksums |
dbdea5cf8c0e5643674d91595d94d2ab76675dd2187ceff0ad48a35b74654c48
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/46.1.3 requests-toolbelt/0.9.1 tqdm/4.42.1 CPython/3.7.6
|
Security for py-sec-xbrl 0.2
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.