XBRL Assembler
.. image:: https://gitlab.com/Reggles44/xbrlassembler/badges/master/pipeline.svg :alt: pipeline status :target: https://gitlab.com/Reggles44/xbrlassembler/-/commits/master
.. image:: https://gitlab.com/Reggles44/xbrlassembler/badges/master/coverage.svg :alt: coverage report :target: https://gitlab.com/Reggles44/xbrlassembler/-/commits/master
.. image:: https://readthedocs.org/projects/xbrlassembler/badge/?version=latest :alt: Documentation Status :target: https://xbrlassembler.readthedocs.io/
XBRLAssembelr is a parsing library for putting xbrldocuments from the sec together into pandas.Dataframe.
Installation
Use the package manager pip to install XBRLAssembler.
.. code-block::bash
python -m pip install xbrlassembler
Usage
XBRLAssembler has two main use cases, local file parsing or SEC index parsing.
The first use can be donw as shown given the SEC statement index url.
.. code-block:: python
from xbrlassembler import XBRLAssembler
google_index = "https://www.sec.gov/Archives/edgar/data/1652044/0001652044-20-000021-index.htm"
assembler = XBRLAssembler.from_sec_index(index_url=google_index)
Alternatively local documents from a specific folder can be the basis for the assembler. This is done by using the from_dir constructor.
.. code-block:: python
from xbrlassembler import XBRLAssembler
assembler = XBRLAssembler.from_dir("C://path/to/files")
To access data from an assembler use the 'get' function. Search for specific documents but the buildin enum, regex, or string.
.. code-block:: python
import re
from xbrlassembler import FinancialStatement
income_statment = assembler.get(FinancialStatement.INCOME_STATEMENT)
income_statment = assembler.get(re.compile(r'Income Statment'))
income_statment = assembler.get('Income Statement')
Get returns an XBRLElement which can be swapped into better forms. XBRLElement.visualize() will return a multiline string containing all data under that node. XBRLElement.to_dataframe() creates a pandas.Dataframe out of the tree
.. code-block:: python
print(income_statement.visualize())
income_dataframe = income_statement.to_dataframe()
Additional documentation for specific functions and errors can be found at, https://xbrlassembler.rtfd.io.
1 maintainer
Metadata
1 maintainer
Release files for XBRLAssembler 0.13.1
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 | |
|---|---|---|---|---|
| XBRLAssembler-0.13.1.tar.gz | 8.1 kB | Without provenance | Details |
Release files / XBRLAssembler-0.13.1.tar.gz
| Download URL | XBRLAssembler-0.13.1.tar.gz |
|---|---|
| Size | 8.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
4f8e53e7c2e862eb1e04abedc518987a0b91ed056ac0a1c1432f55881381da86
|
|
BLAKE2b-256 checksum How to use checksums |
0dc2a40a2248fd0e8e4c2407df12dd1ea6cd0dd472610dada92db7751dc9982b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.2.0 pkginfo/1.6.1 requests/2.25.1 setuptools/51.0.0 requests-toolbelt/0.9.1 tqdm/4.54.1 CPython/3.7.9
|
Security for XBRLAssembler 0.13.1
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.
