SEC EDGAR Parser based on Python 3
Project description
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
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for py_sec_xbrl-0.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b2586bb77cfedf610d41512a7c66ef03f463eec13d27789ad273b86ad55bca5c |
|
MD5 | 2d8a7c754fbeb354f01334ed10ea34fb |
|
BLAKE2b-256 | dbdea5cf8c0e5643674d91595d94d2ab76675dd2187ceff0ad48a35b74654c48 |