https://github.com/tniedbala/secdatatools
Simple Python utility that downloads and extracts SEC financial statement data sets.
https://github.com/tniedbala/secdatatools
accounting analysis csv data dataset finance financial-statements securities tsv utility
Last synced: 10 days ago
JSON representation
Simple Python utility that downloads and extracts SEC financial statement data sets.
- Host: GitHub
- URL: https://github.com/tniedbala/secdatatools
- Owner: tniedbala
- License: mit
- Created: 2017-08-16T02:53:48.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2017-08-16T04:16:34.000Z (over 8 years ago)
- Last Synced: 2024-02-26T02:41:17.196Z (almost 2 years ago)
- Topics: accounting, analysis, csv, data, dataset, finance, financial-statements, securities, tsv, utility
- Language: Python
- Size: 10.7 KB
- Stars: 30
- Watchers: 3
- Forks: 8
- Open Issues: 0
-
Metadata Files:
- Readme: Readme.md
- Changelog: Changelog.md
- License: License
Awesome Lists containing this project
README
## SECDataTools
Simple Python utility that downloads and extracts financial statement zip archives made publicly available by the US Securities and Exchange Comission (SEC) at https://www.sec.gov/dera/data/financial-statement-data-sets.html.
### Requirements
- Python version 3.3 or higher
- Modern version of Windows, Mac OS X, Linux
### Quick Start
*SECDataTools/GetData* may be run as a standalone script. With no arguments provided all available datasets are downloaded to an *./sec_zip* subdirectory within the current working directory, and then extracted to the cwd:
```
$ python SECDataTools/GetData
````
The same can be achieved from within a Python module as follows:
``` python
import SECDataTools as sec
sec.download()
sec.extract()
```
Additional command line and module functionality is available. See [documentation](/docs) for additional details.
### Documentation
1. [Command Line Reference](docs/command_line.md)
2. [Module Reference](docs/module_reference.md)
3. [Extract Options](docs/extract_options.md)
### Project Status
SECDataTools currently retrieves SEC financial statement datasets and is available for Python version 3.3 or higher. Expected updates include:
- Python 2.7 support
- Database tools and utilities
- Support for additional datasets available at https://www.sec.gov/data
### License
[MIT](/License)
### Disclaimer
This software has been created for informational/educational purposes only and is not intended for use in making investment decisions. I make absolutely no guarantees regarding the accuracy, reliability or completeness of information generated in connection with the software and place an added emphasis on all language found within the software's [License](License).