Description

This is simple a class for Python 2.7 that helps you to extract all the relevant information from the SimFin bulk download files.

Code Examples

For an example on how to use the SimFinDataset class, check the sample-extraction.py file.

In short:

Load dataset, specify filename and delimiter ("comma" or "semicolon", depending on what file you downloaded from simfin.com)

dataset = SimFinDataset('sample-data.csv','semicolon')

You can also specify a start and end date for the data points and only keep companies in the dataset that have no missing data values (due to mistakes and/or missing data) by setting the excludeMissing argument to True.

dataset = SimFinDataset('sample-data.csv','semicolon',"2011-01-01","2016-12-31",True)

Print number of indicators (for each company) and number of companies in dataset

print(dataset.numIndicators)
print(dataset.numCompanies)

Print company at index position 1

print(dataset.companies[1])

Print COGS values for this company (index at position 1 is COGS)

print(dataset.companies[1].data[1].values)

Print time periods (strings)

print(dataset.timePeriods)

Print time periods (datetime objects)

print(dataset.timePeriodsDates)

Get company object by ticker

print(dataset.getCompany("AAPL"))

Conversion to XLSX

The processSimfin.py script is used for displaying the data in the CSV in a readable .xlsx file. The script utilizes xlsxWritter to generate the xlsx files.

Created by @ranm and extended by @VitBu

You need to install xlsxWritter:

$ pip install XlsxWriter

Command line arguments are available when running --help

usage example :

 $ ./processSimfin.py --inputFile=sample-data.csv --minYear=2016

getting info of specific companies by tickers:

 $ ./processSimfin.py --inputFile=sample-data.csv --minYear=2016 --tickers=AAPL,MSFT

Available under MIT license.