├── mftracker ├── __init__.py ├── latestNavClass.py ├── mflconst.py ├── portfolioUtils.py ├── mfDatabaseClass.py └── parseTransactionsClass.py ├── requirements.txt ├── myPortfolioScript.py ├── README.md ├── transactions_test.csv └── LICENSE /mftracker/__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | certifi==2023.7.22 2 | chardet==3.0.4 3 | idna==2.9 4 | python-dateutil==2.8.1 5 | requests==2.23.0 6 | six==1.14.0 7 | urllib3==1.26.5 8 | -------------------------------------------------------------------------------- /myPortfolioScript.py: -------------------------------------------------------------------------------- 1 | from mftracker.latestNavClass import LatestNavClass 2 | from mftracker.mfDatabaseClass import MFDatabaseClass 3 | from mftracker.parseTransactionsClass import parseTransactionsClass 4 | from mftracker.portfolioUtils import * 5 | import argparse 6 | import logging.config 7 | 8 | 9 | def main(): 10 | logFormatter = logging.Formatter("%(asctime)s [%(module)-12.12s] [%(levelname)-5.5s] %(message)s") 11 | rootLogger = logging.getLogger() 12 | rootLogger.setLevel(level=logging.DEBUG) 13 | 14 | fileHandler = logging.FileHandler("mfl.log") 15 | fileHandler.setFormatter(logFormatter) 16 | fileHandler.setLevel(level=logging.DEBUG) 17 | 18 | 19 | consoleHandler = logging.StreamHandler() 20 | consoleHandler.setLevel(level=logging.INFO) 21 | consoleHandler.setFormatter(logFormatter) 22 | 23 | rootLogger.addHandler(fileHandler) 24 | rootLogger.addHandler(consoleHandler) 25 | import sys; 26 | rootLogger.info('Python %s on %s' % (sys.version, sys.platform)) 27 | rootLogger.info("Starting...") 28 | 29 | parser = argparse.ArgumentParser() 30 | parser.add_argument("filename", help="csv file containing transactions") 31 | args = parser.parse_args() 32 | rootLogger.info("File name passed is " + args.filename) 33 | 34 | ln = LatestNavClass() 35 | mfdb = MFDatabaseClass() 36 | 37 | pt = parseTransactionsClass(args.filename, mfdb) 38 | calculateEntirePortfolioProgress_Eq_De(pt) 39 | 40 | 41 | if __name__ == '__main__': 42 | main() 43 | -------------------------------------------------------------------------------- /mftracker/latestNavClass.py: -------------------------------------------------------------------------------- 1 | import requests 2 | import re 3 | import logging 4 | from .mflconst import * 5 | 6 | log = logging.getLogger(__name__) 7 | 8 | 9 | class LatestNavClass(object): 10 | def __init__(self, url=DEFAULT_NAV_URL): 11 | log.info("Getting the latest NAV..") 12 | self.__navdetails = {} 13 | self.__indexPositions = {} 14 | r = requests.get(url) 15 | if r.status_code != 200: 16 | log.debug(ERROR0_TEXT) 17 | exit() 18 | 19 | if 'text/plain' in r.headers.get('content-type'): 20 | pat = ".*;.*" 21 | foundheader = 0 22 | intrestedlines = re.findall(pat, r.text) 23 | for eachline in intrestedlines: 24 | #line = eachline.encode('ascii', 'ignore').strip('\r') 25 | line = eachline.strip('\r') 26 | if foundheader != 4: 27 | for i in [SCHCODE_STRING, SCHNAME_STRING, NAV_STRING, DATE_STRING]: 28 | if i in line: 29 | #print(line.split(";")) 30 | indexpos = line.split(";").index(i) 31 | self.__indexPositions[i] = indexpos 32 | foundheader = foundheader + 1 33 | else: 34 | schc = line.split(";")[self.__indexPositions[SCHCODE_STRING]] 35 | schn = line.split(";")[self.__indexPositions[SCHNAME_STRING]] 36 | nav = line.split(";")[self.__indexPositions[NAV_STRING]] 37 | navdate = line.split(";")[self.__indexPositions[DATE_STRING]] 38 | self.__navdetails[schc] = [schn, nav, navdate] 39 | else: 40 | log.debug(ERROR1_TEXT) 41 | exit() 42 | 43 | def getNav(self, schcode): 44 | return self.__navdetails[str(schcode)][1] 45 | 46 | def getNavAndDate(self, schcode): 47 | return self.__navdetails[str(schcode)][1], self.__navdetails[str(schcode)][2] 48 | 49 | def getSchNameNavAndDate(self, schcode): 50 | return self.__navdetails[str(schcode)][0], self.__navdetails[str(schcode)][1], self.__navdetails[str(schcode)][ 51 | 2] 52 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Mutual fund portfolio Tracker 2 | 3 | A simple DIY mutual fund tracker written in python. 4 | For more info, please check the post https://duddukaasu.wordpress.com/2020/08/04/how-do-you-track-your-portfolio/ 5 | 6 | **How to use** 7 | - 8 | 1) Download the package 9 | 2) Execute `pip install -r requirements.txt` 10 | 3) Execute `python3 myPortfolioScript.py transactions.csv` 11 | 12 | Once you execute the above under the `mfl_tmp` directory you will see a folder `sch` you will see induvidual schemes progress on a daily basis, open the csv in an excel file and plot for more details. 13 | Also after the run you will see these files 14 | `EmergencyPortFolioProgress.csv` - transactions which are tagged under goal emergency 15 | 16 | `RetirementEquityPortFolioProgress.csv` - transactions which are tagged under goal retirement 17 | 18 | `ChildEducationEquityPortFolioProgress.csv` - transactions which are tagged under goal child education 19 | 20 | `OverallEquityPortFolioProgress.csv` - transactions which are tagged equity 21 | 22 | `OverallDebtPortFolioProgress.csv` - transactions which are tagged debt 23 | 24 | `OverallEntirePortFolioProgress.csv` - transactions which are tagged equity and debt, this is the entire portfolio 25 | 26 | Currently only goals 'Emergency' , 'Retirement' , 'ChildEducation' are supported 27 | 28 | **How should the `transactions.csv` file look like** 29 | - 30 | 31 | | Date | Scheme Code | Scheme Name | Type | Price | Units | Amount | Equity/Debt | Goal | 32 | | ------------- | ------------- | ------------- | ------------- | ------------- | ------------- | ------------- | ------------- |------------- | 33 | 34 | Example: 35 | 36 | | Date | Scheme Code | Scheme Name | Type | Price | Units | Amount | Equity/Debt | Goal | 37 | | ------------- | ------------- | ------------- | ------------- | ------------- | ------------- | ------------- | ------------- |------------- | 38 | | 08-Jun-12| 101762| HDFC Equity Fund - Growth Option| Buy| 248.692| 4.021| 1000| Equity| Retirement 39 | | 08-Jun-12| 101922| Canara Robeco Equity Diversified Fund - Regular Plan - Growth| Buy| 53.73| 18.612| 1000| Equity| ChildEducation 40 | | 11-Jun-12| 101762| HDFC Equity Fund - Growth Option| Buy| 247.975| 8.065| 2000| Equity| Retirement 41 | | 11-Jun-12| 101922| Canara Robeco Equity Diversified Fund - Regular Plan - Growth| Buy| 53.69| 37.251| 2000| Equity| ChildEducation 42 | | 12-Jun-12| 108466| ICICI Prudential Bluechip Fund - Growth| Buy| 15.75| 126.984| 2000| Equity| Retirement 43 | | 12-Jun-12| 102000| HDFC Top 100 Fund - Growth Option| Buy| 193.745| 10.323| 2000| Equity| Retirement 44 | 45 | Please make sure that the column header has same names as shown above. 46 | 47 | 48 | Scheme codes can be got from http://portal.amfiindia.com/spages/NAVopen.txt 49 | 50 | Please mail me at srbharadwaj at gmail dot com for any issues. 51 | 52 | -------------------------------------------------------------------------------- /mftracker/mflconst.py: -------------------------------------------------------------------------------- 1 | import string 2 | 3 | # Defaults do NOT change it 4 | VERSION = 1.0 5 | 6 | DEFAULT_NAV_URL = "http://portal.amfiindia.com/spages/NAVopen.txt" 7 | # http://portal.amfiindia.com/DownloadNAVHistoryReport_Po.aspx?mf=26&tp=1&frmdt=03-Sep-2002&todt=05-Sep-2018 8 | NAV_HISTORY_URL = "http://portal.amfiindia.com/DownloadNAVHistoryReport_Po.aspx?mf={0}&tp=1&frmdt={1}&todt={2}" 9 | # https://www.nseindia.com/products/dynaContent/equities/indices/total_returnindices.jsp?indexType=NIFTY%20NEXT%2050&fromDate=28-12-2015&toDate=10-2-2016 10 | INDEX_URL = "https://www1.nseindia.com/products/dynaContent/equities/indices/total_returnindices.jsp?indexType={0}&fromDate={1}&toDate={2}" 11 | 12 | MFDB_FILENAME = "mfl_tmp/mfdb.csv" # AMCCODE,AMCNAME,SCHCODE,SCHNAME 13 | NAV_PATH = "mfl_tmp/nav/" 14 | SCH_PATH = "mfl_tmp/sch/" 15 | INDEX_PATH = "mfl_tmp/index/" 16 | SCHDETAILS_PATH = "schdetails/" 17 | TRANS_DATE_STRING = "Date" 18 | TRANS_SCHCODE_STRING = "Scheme Code" 19 | TRANS_SCHNAME_STRING = "Scheme Name" 20 | TRANS_UNITS = "Units" 21 | TRANS_AMOUNT = "Amount" 22 | TRANS_EORD = "Equity/Debt" 23 | TRANS_TYPE = "Type" 24 | TRANS_PRICE = "Price" 25 | TRANS_GOAL = "Goal" 26 | 27 | SCHCODE_STRING = "Scheme Code" 28 | SCHNAME_STRING = "Scheme Name" 29 | NAV_STRING = "Net Asset Value" 30 | DATE_STRING = "Date" 31 | ERROR0_TEXT = "ERROR:1: Unable to get NAV data, status code is not 200, please contact Suhas (srbharadwaj@gmail.com)" 32 | ERROR1_TEXT = "ERROR:0: Unable to get NAV data, please contact Suhas (srbharadwaj@gmail.com)" 33 | ERROR2_TEXT = "ERROR:1: Unable to get NAV History data, status code is not 200, please contact Suhas (srbharadwaj@gmail.com)" 34 | ERROR3_TEXT = "ERROR:0: Unable to get NAV History data, please contact Suhas (srbharadwaj@gmail.com)" 35 | DDMMMYYYY_FORMAT = "%d-%b-%Y" 36 | DDMMYYYY_FORMAT = "%d-%m-%Y" 37 | MAX_AMC_CODE_RANGE = 100 38 | START_DATE = "03-Apr-2006" 39 | INDEX_START_DATE = "01-01-1989" 40 | 41 | # Indexs 42 | NIFTY50 = "NIFTY 50" 43 | NIFTYNEXT50 = "NIFTY NEXT 50" 44 | NIFTY100 = "NIFTY 100" 45 | NIFTY200 = "NIFTY 200" 46 | NIFTY500 = "NIFTY 500" 47 | NIFTYMIDCAP150 = "NIFTY MIDCAP 150" 48 | NIFTYMIDCAP50 = "NIFTY MIDCAP 50" 49 | NIFTYMIDCAP100 = "NIFTY MIDCAP 100" 50 | NIFTY100EW = "NIFTY100 EQUAL WEIGHT" 51 | NIFTYLARGEMIDCAP250 = "NIFTY LARGEMIDCAP 250" 52 | NIFTYMIDCAP150QUAITY50 = "NIFTY MIDCAP150 QUALITY 50" 53 | NIFTYSMALLCAP250 = "NIFTY SMALLCAP 250" 54 | NIFTY500VALUE50 = "NIFTY500 VALUE 50" 55 | 56 | # LIST_OF_INDEXES = [NIFTY50,NIFTYNEXT50,NIFTY200,NIFTY100,NIFTY500,NIFTY100EW,NIFTYMIDCAP150,NIFTYMIDCAP50,NIFTYMIDCAP100,NIFTYLARGEMIDCAP250,NIFTYMIDCAP150QUAITY50] 57 | LIST_OF_INDEXES = [NIFTY100, NIFTY50, NIFTYNEXT50, NIFTYMIDCAP150, NIFTYSMALLCAP250,NIFTY500VALUE50] 58 | 59 | 60 | #BT CONSTANTS 61 | AMT = 1000 62 | NUMYEARS = 20 63 | EQR = 12 64 | DER = 7 65 | REBALANCE = True 66 | EQRATIO = None 67 | 68 | ''' 69 | A single function that calculates IRR using Newton's Method 70 | ''' 71 | 72 | 73 | def xirr(transactions): 74 | ''' 75 | Calculates the Internal Rate of Return (IRR) for an irregular series of cash flows (XIRR) 76 | Takes a list of tuples [(date,cash-flow),(date,cash-flow),...] 77 | Returns a rate of return as a percentage 78 | ''' 79 | 80 | years = [(ta[0] - transactions[0][0]).days / 365. for ta in transactions] 81 | 82 | all_less_than_a_year = True 83 | for eachy in years: 84 | if eachy >= 1: 85 | all_less_than_a_year = False 86 | break 87 | if all_less_than_a_year: 88 | return 0 89 | residual = 1.0 90 | step = 0.05 91 | guess = 0.05 92 | epsilon = 0.0001 93 | limit = 10000 94 | while abs(residual) > epsilon and limit > 0: 95 | limit -= 1 96 | residual = 0.0 97 | for i, trans in enumerate(transactions): 98 | # print i,trans 99 | try: 100 | residual += trans[1] / pow(guess, years[i]) 101 | except ZeroDivisionError: 102 | continue 103 | except ValueError: 104 | continue 105 | if abs(residual) > epsilon: 106 | if residual > 0: 107 | guess += step 108 | else: 109 | guess -= step 110 | step /= 2.0 111 | return guess - 1 112 | 113 | 114 | # https://gist.github.com/seanh/93666 115 | def format_filename(s): 116 | """Take a string and return a valid filename constructed from the string. 117 | Uses a whitelist approach: any characters not present in valid_chars are 118 | removed. Also spaces are replaced with underscores. 119 | 120 | Note: this method may produce invalid filenames such as ``, `.` or `..` 121 | When I use this method I prepend a date string like '2009_01_15_19_46_32_' 122 | and append a file extension like '.txt', so I avoid the potential of using 123 | an invalid filename. 124 | 125 | """ 126 | valid_chars = "-_.() %s%s" % (string.ascii_letters, string.digits) 127 | filename = ''.join(c for c in s if c in valid_chars) 128 | filename = filename.replace(' ', '_') # I don't like spaces in filenames. 129 | return filename 130 | -------------------------------------------------------------------------------- /mftracker/portfolioUtils.py: -------------------------------------------------------------------------------- 1 | from dateutil.parser import parse 2 | from .mflconst import * 3 | from collections import OrderedDict 4 | import csv 5 | 6 | import logging 7 | 8 | log = logging.getLogger(__name__) 9 | 10 | 11 | def getAllXIRR(pt, finalOveralEverythinglDict, eod="All", goal=None): 12 | log.info("Get getAllXIRR for eod: " + eod + " Goal: " + str(goal) + " ....") 13 | finalout = {} 14 | for d, v in finalOveralEverythinglDict.items(): 15 | alltrans = {} 16 | tv = v[1] 17 | for schcode, eachSchObj in pt.allMFTransactionsObjs.items(): 18 | if goal is None: 19 | if eod == "All": 20 | pass 21 | elif eachSchObj.eod.strip().lower() == eod.lower(): 22 | pass 23 | else: 24 | continue 25 | else: 26 | if goal.lower() == eachSchObj.goal.strip().lower(): 27 | if eod == "All": 28 | pass 29 | elif eachSchObj.eod.strip().lower() == eod.lower(): 30 | pass 31 | else: 32 | continue 33 | else: 34 | continue 35 | 36 | transOrd = eachSchObj.getListOfOrdTrans(tilld=d) 37 | if transOrd: 38 | for eachd, val in transOrd.items(): 39 | type = val[0] 40 | amt = val[3] 41 | if eachd in alltrans.keys(): 42 | a = alltrans[eachd] 43 | if type.lower() == 'buy': 44 | a = a - amt 45 | else: 46 | a = a + amt 47 | alltrans[eachd] = a 48 | else: 49 | if type.lower() == 'buy': 50 | alltrans[eachd] = -amt 51 | else: 52 | alltrans[eachd] = amt 53 | 54 | if parse(d) in alltrans.keys(): 55 | a = alltrans[parse(d)] 56 | a = a + tv 57 | alltrans[parse(d)] = a 58 | else: 59 | alltrans[parse(d)] = tv 60 | cashflows = [] 61 | for dobj, amt in alltrans.items(): 62 | cashflows.append((dobj.date(), amt)) 63 | # print cashflows 64 | cashflowsorted = sorted(cashflows, key=lambda x: x[0]) 65 | xirrval = xirr(cashflowsorted) 66 | xirrval_str = "{:.2%}".format(xirrval) 67 | finalout[d] = xirrval_str 68 | # print finalout 69 | return finalout 70 | 71 | 72 | def getFinalOverAllDict(pt, eod=None, goal=None): 73 | retDict = OrderedDict() 74 | 75 | overall_fd = [] 76 | for schcode, eachSchObj in pt.allMFTransactionsObjs.items(): 77 | for eachk in eachSchObj.cumulativeAllDatesData.keys(): 78 | if goal is None: 79 | if eod is None: 80 | d = parse(eachk) 81 | overall_fd.append(d) 82 | elif eachSchObj.eod.lower() == eod.lower(): 83 | d = parse(eachk) 84 | overall_fd.append(d) 85 | else: 86 | continue 87 | else: 88 | if goal.lower() == eachSchObj.goal.lower(): 89 | if eod is None: 90 | d = parse(eachk) 91 | overall_fd.append(d) 92 | elif eachSchObj.eod.lower() == eod.lower(): 93 | d = parse(eachk) 94 | overall_fd.append(d) 95 | else: 96 | continue 97 | 98 | od = list(set(overall_fd)) 99 | od.sort() 100 | 101 | for eachd in od: 102 | ta_all = 0 103 | tv_all = 0 104 | for schcode, eachSchObj in pt.allMFTransactionsObjs.items(): 105 | if goal is None: 106 | if eod is None: 107 | out = eachSchObj.getLatestTaAndTv(eachd) 108 | ta_all = ta_all + out[0] 109 | tv_all = tv_all + out[1] 110 | elif eachSchObj.eod.lower() == eod.lower(): 111 | out = eachSchObj.getLatestTaAndTv(eachd) 112 | ta_all = ta_all + out[0] 113 | tv_all = tv_all + out[1] 114 | # print("Getting for " + eod) 115 | # print(eachd,ta_all,tv_all) 116 | else: 117 | continue 118 | else: 119 | if goal.lower() == eachSchObj.goal.lower(): 120 | if eod is None: 121 | out = eachSchObj.getLatestTaAndTv(eachd) 122 | ta_all = ta_all + out[0] 123 | tv_all = tv_all + out[1] 124 | elif eachSchObj.eod.lower() == eod.lower(): 125 | out = eachSchObj.getLatestTaAndTv(eachd) 126 | ta_all = ta_all + out[0] 127 | tv_all = tv_all + out[1] 128 | else: 129 | continue 130 | else: 131 | continue 132 | if tv_all > 0: 133 | retDict[eachd.strftime(DDMMMYYYY_FORMAT)] = [ta_all, tv_all, tv_all - ta_all] 134 | for schcode, eachSchObj in pt.allMFTransactionsObjs.items(): 135 | eachSchObj.resetLatestTaAndTv() 136 | return retDict 137 | 138 | 139 | def calculateEntirePortfolioProgress_Eq_De(pt): 140 | log.info("Calculating OverallEntirePortFolioProgress...") 141 | 142 | # print od 143 | 144 | finalOveralEverythinglDict = getFinalOverAllDict(pt) 145 | finalOverallEquityDict = getFinalOverAllDict(pt, eod="Equity") 146 | finalOverallDebtDict = getFinalOverAllDict(pt, eod="Debt") 147 | 148 | overallxirr = getAllXIRR(pt, finalOveralEverythinglDict) 149 | with open("OverallEntirePortFolioProgress.csv", mode='w') as f: 150 | log.info("Writing OverallEntirePortFolioProgress...") 151 | w = csv.writer(f) 152 | w.writerow(["Date", "Total Amount", "Total Value", "Gains/Losses", "XIRR"]) 153 | for d, v in finalOveralEverythinglDict.items(): 154 | w.writerow([d] + v + [overallxirr[d]]) 155 | 156 | eqxirr = getAllXIRR(pt, finalOverallEquityDict, eod="Equity") 157 | with open("OverallEquityPortFolioProgress.csv", mode='w') as f: 158 | log.info("Writing OverallEquityPortFolioProgress...") 159 | w = csv.writer(f) 160 | w.writerow(["Date", "Total Amount", "Total Value", "Gains/Losses", "XIRR"]) 161 | for d, v in finalOverallEquityDict.items(): 162 | w.writerow([d] + v + [eqxirr[d]]) 163 | 164 | dexirr = getAllXIRR(pt, finalOverallDebtDict, eod="Debt") 165 | with open("OverallDebtPortFolioProgress.csv", mode='w') as f: 166 | log.info("Writing OverallDebtPortFolioProgress...") 167 | w = csv.writer(f) 168 | w.writerow(["Date", "Total Amount", "Total Value", "Gains/Losses", "XIRR"]) 169 | for d, v in finalOverallDebtDict.items(): 170 | w.writerow([d] + v + [dexirr[d]]) 171 | 172 | # Goals 173 | GoalOverallEquityRetlDict = getFinalOverAllDict(pt, eod="Equity", goal="Retirement") 174 | GoalOverallEquityChildEdulDict = getFinalOverAllDict(pt, eod="Equity", goal="ChildEducation") 175 | GoalOverallEquityEmerDict = getFinalOverAllDict(pt, eod="Debt", goal="Emergency") 176 | 177 | goal_eqxirr = getAllXIRR(pt, GoalOverallEquityRetlDict, eod="Equity", goal="Retirement") 178 | with open("RetirementEquityPortFolioProgress.csv", mode='w') as f: 179 | log.info("Writing RetirementEquityPortFolioProgress...") 180 | w = csv.writer(f) 181 | w.writerow(["Date", "Total Amount", "Total Value", "Gains/Losses", "XIRR"]) 182 | for d, v in GoalOverallEquityRetlDict.items(): 183 | w.writerow([d] + v + [goal_eqxirr[d]]) 184 | 185 | goal_eqxirr = getAllXIRR(pt, GoalOverallEquityChildEdulDict, eod="Equity", goal="ChildEducation") 186 | with open("ChildEducationEquityPortFolioProgress.csv", mode='w') as f: 187 | log.info("Writing ChildEducationEquityPortFolioProgress...") 188 | w = csv.writer(f) 189 | w.writerow(["Date", "Total Amount", "Total Value", "Gains/Losses", "XIRR"]) 190 | for d, v in GoalOverallEquityChildEdulDict.items(): 191 | w.writerow([d] + v + [goal_eqxirr[d]]) 192 | 193 | goal_eqxirr = getAllXIRR(pt, GoalOverallEquityEmerDict, eod="Debt", goal="Emergency") 194 | with open("EmergencyPortFolioProgress.csv", mode='w') as f: 195 | log.info("Writing EmergencyPortFolioProgress...") 196 | w = csv.writer(f) 197 | w.writerow(["Date", "Total Amount", "Total Value", "Gains/Losses", "XIRR"]) 198 | for d, v in GoalOverallEquityEmerDict.items(): 199 | w.writerow([d] + v + [goal_eqxirr[d]]) -------------------------------------------------------------------------------- /transactions_test.csv: -------------------------------------------------------------------------------- 1 | Date,Scheme Code,Scheme Name,Type,Price,Units, Amount ,Equity/Debt,Goal 2 | 08-Jun-12,101762,HDFC Equity Fund - Growth Option,Buy,248.692,4.021,1000,Equity,Retirement 3 | 08-Jun-12,101922,Canara Robeco Equity Diversified Fund - Regular Plan - Growth,Buy,53.73,18.612,1000,Equity,ChildEducation 4 | 11-Jun-12,101762,HDFC Equity Fund - Growth Option,Buy,247.975,8.065,2000,Equity,Retirement 5 | 11-Jun-12,101922,Canara Robeco Equity Diversified Fund - Regular Plan - Growth,Buy,53.69,37.251,2000,Equity,ChildEducation 6 | 12-Jun-12,108466,ICICI Prudential Bluechip Fund - Growth,Buy,15.75,126.984,2000,Equity,Retirement 7 | 12-Jun-12,102000,HDFC Top 100 Fund - Growth Option,Buy,193.745,10.323,2000,Equity,Retirement 8 | 28-Jun-12,108466,ICICI Prudential Bluechip Fund - Growth,Buy,15.89,188.798,3000,Equity,Retirement 9 | 28-Jun-12,102000,HDFC Top 100 Fund - Growth Option,Buy,195.127,10.25,2000,Equity,Retirement 10 | 28-Jun-12,101762,HDFC Equity Fund - Growth Option,Buy,252.187,7.931,2000,Equity,Retirement 11 | 28-Jun-12,101922,Canara Robeco Equity Diversified Fund - Regular Plan - Growth,Buy,54.88,54.665,3000,Equity,ChildEducation 12 | 30-Jul-12,103159,Tata Treasury Advantage Fund - Regular Plan - Growth,Buy,1659.0145,18.083,30000,Debt,Emergency 13 | 30-Jul-12,108466,ICICI Prudential Bluechip Fund - Growth,Buy,16.1,186.335,3000,Equity,Retirement 14 | 30-Jul-12,102000,HDFC Top 100 Fund - Growth Option,Buy,196.234,10.192,2000,Equity,Retirement 15 | 30-Jul-12,101762,HDFC Equity Fund - Growth Option,Buy,253.902,7.877,2000,Equity,Retirement 16 | 30-Jul-12,113135,Franklin India Low Duration Fund - Growth Plan,Buy,11.9675,2506.789,30000,Debt,Emergency 17 | 30-Jul-12,101922,Canara Robeco Equity Diversified Fund - Regular Plan - Growth,Buy,55.81,53.754,3000,Equity,ChildEducation 18 | 28-Aug-12,108466,ICICI Prudential Bluechip Fund - Growth,Buy,16.4,182.927,3000,Equity,Retirement 19 | 28-Aug-12,102000,HDFC Top 100 Fund - Growth Option,Buy,195.682,10.221,2000,Equity,Retirement 20 | 28-Aug-12,101762,HDFC Equity Fund - Growth Option,Buy,250.964,7.969,2000,Equity,Retirement 21 | 28-Aug-12,101922,Canara Robeco Equity Diversified Fund - Regular Plan - Growth,Buy,56.09,53.485,3000,Equity,ChildEducation 22 | 28-Sep-12,108466,ICICI Prudential Bluechip Fund - Growth,Buy,17.6,170.455,3000,Equity,Retirement 23 | 28-Sep-12,102000,HDFC Top 100 Fund - Growth Option,Buy,214.299,9.333,2000,Equity,Retirement 24 | 28-Sep-12,101762,HDFC Equity Fund - Growth Option,Buy,276.571,7.231,2000,Equity,Retirement 25 | 28-Sep-12,101922,Canara Robeco Equity Diversified Fund - Regular Plan - Growth,Buy,60.24,49.801,3000,Equity,ChildEducation 26 | 29-Oct-12,108466,ICICI Prudential Bluechip Fund - Growth,Buy,17.44,172.018,3000,Equity,Retirement 27 | 29-Oct-12,102000,HDFC Top 100 Fund - Growth Option,Buy,211.965,9.436,2000,Equity,Retirement 28 | 29-Oct-12,101762,HDFC Equity Fund - Growth Option,Buy,274.618,7.283,2000,Equity,Retirement 29 | 29-Oct-12,101922,Canara Robeco Equity Diversified Fund - Regular Plan - Growth,Buy,60.44,49.636,3000,Equity,ChildEducation 30 | 29-Nov-12,108466,ICICI Prudential Bluechip Fund - Growth,Buy,18.19,164.926,3000,Equity,Retirement 31 | 29-Nov-12,102000,HDFC Top 100 Fund - Growth Option,Buy,218.469,9.155,2000,Equity,Retirement 32 | 29-Nov-12,101762,HDFC Equity Fund - Growth Option,Buy,281.363,7.108,2000,Equity,Retirement 33 | 29-Nov-12,101922,Canara Robeco Equity Diversified Fund - Regular Plan - Growth,Buy,62.34,48.123,3000,Equity,ChildEducation 34 | 10-Dec-12,101762,HDFC Equity Fund - Growth Option,Sell,288.516,57.485,16585.33,Equity,Retirement 35 | 18-Dec-12,103490,Quantum Long Term Equity Value Fund - Direct Plan Growth Option,Buy,24.87,80.418,2000,Equity,Retirement 36 | 28-Dec-12,108466,ICICI Prudential Bluechip Fund - Growth,Buy,18.41,162.955,3000,Equity,Retirement 37 | 28-Dec-12,102000,HDFC Top 100 Fund - Growth Option,Buy,226.031,8.848,2000,Equity,Retirement 38 | 28-Dec-12,101922,Canara Robeco Equity Diversified Fund - Regular Plan - Growth,Buy,63.27,47.416,3000,Equity,ChildEducation 39 | 28-Dec-12,103490,Quantum Long Term Equity Value Fund - Direct Plan Growth Option,Buy,25.08,79.745,2000,Equity,Retirement 40 | 21-Jan-13,103159,Tata Treasury Advantage Fund - Regular Plan - Growth,Sell,1729.1127,18.083,31267.54,Debt,Emergency 41 | 21-Jan-13,113135,Franklin India Low Duration Fund - Growth Plan,Sell,12.5014,2506.789,31338.37,Debt,Emergency 42 | 28-Jan-13,108466,ICICI Prudential Bluechip Fund - Growth,Buy,19.01,157.812,3000,Equity,Retirement 43 | 28-Jan-13,102000,HDFC Top 100 Fund - Growth Option,Buy,232.708,8.594,2000,Equity,Retirement 44 | 28-Jan-13,101922,Canara Robeco Equity Diversified Fund - Regular Plan - Growth,Buy,64.34,46.627,3000,Equity,ChildEducation 45 | 28-Jan-13,103490,Quantum Long Term Equity Value Fund - Direct Plan Growth Option,Buy,25.99,76.953,2000,Equity,Retirement 46 | 28-Feb-13,108466,ICICI Prudential Bluechip Fund - Growth,Buy,17.85,168.067,3000,Equity,Retirement 47 | 28-Feb-13,102000,HDFC Top 100 Fund - Growth Option,Buy,212.692,9.403,2000,Equity,Retirement 48 | 28-Feb-13,101922,Canara Robeco Equity Diversified Fund - Regular Plan - Growth,Buy,59.62,50.319,3000,Equity,ChildEducation 49 | 28-Feb-13,103490,Quantum Long Term Equity Value Fund - Direct Plan Growth Option,Buy,24.71,80.939,2000,Equity,Retirement 50 | 07-Mar-13,113096,IDBI Liquid Fund-Growth,Buy,1251.4694,39.953,50000,Debt,Emergency 51 | 28-Mar-13,108466,ICICI Prudential Bluechip Fund - Growth,Buy,17.65,169.972,3000,Equity,Retirement 52 | 28-Mar-13,102000,HDFC Top 100 Fund - Growth Option,Buy,210.485,9.502,2000,Equity,Retirement 53 | 28-Mar-13,101922,Canara Robeco Equity Diversified Fund - Regular Plan - Growth,Buy,59.32,50.573,3000,Equity,ChildEducation 54 | 28-Mar-13,103490,Quantum Long Term Equity Value Fund - Direct Plan Growth Option,Buy,24.3,82.305,2000,Equity,Retirement 55 | 29-Apr-13,108466,ICICI Prudential Bluechip Fund - Growth,Buy,18.31,163.845,3000,Equity,Retirement 56 | 29-Apr-13,102000,HDFC Top 100 Fund - Growth Option,Buy,220.025,9.09,2000,Equity,Retirement 57 | 29-Apr-13,101922,Canara Robeco Equity Diversified Fund - Regular Plan - Growth,Buy,61.31,48.932,3000,Equity,ChildEducation 58 | 29-Apr-13,103490,Quantum Long Term Equity Value Fund - Direct Plan Growth Option,Buy,25.15,79.523,2000,Equity,Retirement 59 | 28-May-13,108466,ICICI Prudential Bluechip Fund - Growth,Buy,18.82,159.405,3000,Equity,Retirement 60 | 28-May-13,102000,HDFC Top 100 Fund - Growth Option,Buy,224.866,8.894,2000,Equity,Retirement 61 | 28-May-13,101922,Canara Robeco Equity Diversified Fund - Regular Plan - Growth,Buy,63.07,47.566,3000,Equity,ChildEducation 62 | 28-May-13,103490,Quantum Long Term Equity Value Fund - Direct Plan Growth Option,Buy,25.27,79.145,2000,Equity,Retirement 63 | 28-Jun-13,108466,ICICI Prudential Bluechip Fund - Growth,Buy,18.01,166.574,3000,Equity,Retirement 64 | 28-Jun-13,102000,HDFC Top 100 Fund - Growth Option,Buy,210.742,9.49,2000,Equity,Retirement 65 | 28-Jun-13,101922,Canara Robeco Equity Diversified Fund - Regular Plan - Growth,Buy,60.24,49.801,3000,Equity,ChildEducation 66 | 28-Jun-13,103490,Quantum Long Term Equity Value Fund - Direct Plan Growth Option,Buy,24.29,82.338,2000,Equity,Retirement 67 | 28-Jul-13,113096,IDBI Liquid Fund-Growth,Buy,1289.0741,77.575,100000,Debt,Emergency 68 | 29-Jul-13,108466,ICICI Prudential Bluechip Fund - Growth,Buy,18.03,221.852,4000,Equity,Retirement 69 | 29-Jul-13,102000,HDFC Top 100 Fund - Growth Option,Buy,203.953,14.709,3000,Equity,Retirement 70 | 29-Jul-13,101922,Canara Robeco Equity Diversified Fund - Regular Plan - Growth,Buy,60.62,65.985,4000,Equity,ChildEducation 71 | 29-Jul-13,103490,Quantum Long Term Equity Value Fund - Direct Plan Growth Option,Buy,24.04,124.792,3000,Equity,Retirement 72 | 28-Aug-13,108466,ICICI Prudential Bluechip Fund - Growth,Buy,16.95,235.988,4000,Equity,Retirement 73 | 28-Aug-13,102000,HDFC Top 100 Fund - Growth Option,Buy,187.014,16.042,3000,Equity,Retirement 74 | 28-Aug-13,101922,Canara Robeco Equity Diversified Fund - Regular Plan - Growth,Buy,55.94,71.505,4000,Equity,ChildEducation 75 | 28-Aug-13,103490,Quantum Long Term Equity Value Fund - Direct Plan Growth Option,Buy,22.41,133.869,3000,Equity,Retirement 76 | 30-Sep-13,108466,ICICI Prudential Bluechip Fund - Growth,Buy,18.35,217.984,4000,Equity,Retirement 77 | 30-Sep-13,102000,HDFC Top 100 Fund - Growth Option,Buy,202.005,14.851,3000,Equity,Retirement 78 | 30-Sep-13,101922,Canara Robeco Equity Diversified Fund - Regular Plan - Growth,Buy,59.95,66.722,4000,Equity,ChildEducation 79 | 30-Sep-13,103490,Quantum Long Term Equity Value Fund - Direct Plan Growth Option,Buy,24.31,123.406,3000,Equity,Retirement 80 | 28-Oct-13,108466,ICICI Prudential Bluechip Fund - Growth,Buy,19.44,205.761,4000,Equity,Retirement 81 | 28-Oct-13,102000,HDFC Top 100 Fund - Growth Option,Buy,217.296,13.806,3000,Equity,Retirement 82 | 28-Oct-13,101922,Canara Robeco Equity Diversified Fund - Regular Plan - Growth,Buy,63.3,63.191,4000,Equity,ChildEducation 83 | 28-Oct-13,103490,Quantum Long Term Equity Value Fund - Direct Plan Growth Option,Buy,25.75,116.505,3000,Equity,Retirement 84 | 28-Nov-13,108466,ICICI Prudential Bluechip Fund - Growth,Buy,19.6,204.082,4000,Equity,Retirement 85 | 28-Nov-13,102000,HDFC Top 100 Fund - Growth Option,Buy,223.642,13.414,3000,Equity,Retirement 86 | 28-Nov-13,101922,Canara Robeco Equity Diversified Fund - Regular Plan - Growth,Buy,63.36,63.131,4000,Equity,ChildEducation 87 | 28-Nov-13,103490,Quantum Long Term Equity Value Fund - Direct Plan Growth Option,Buy,26.48,113.293,3000,Equity,Retirement 88 | 31-Dec-13,108466,ICICI Prudential Bluechip Fund - Growth,Buy,20.29,197.141,4000,Equity,Retirement 89 | 31-Dec-13,102000,HDFC Top 100 Fund - Growth Option,Buy,235.401,12.744,3000,Equity,Retirement 90 | 31-Dec-13,101922,Canara Robeco Equity Diversified Fund - Regular Plan - Growth,Buy,66.13,60.487,4000,Equity,ChildEducation 91 | 31-Dec-13,103490,Quantum Long Term Equity Value Fund - Direct Plan Growth Option,Buy,27.4,109.489,3000,Equity,Retirement -------------------------------------------------------------------------------- /mftracker/mfDatabaseClass.py: -------------------------------------------------------------------------------- 1 | import errno 2 | from datetime import datetime 3 | import requests 4 | import re 5 | import csv 6 | import os 7 | import logging 8 | from .mflconst import * 9 | 10 | log = logging.getLogger(__name__) 11 | from multiprocessing.pool import ThreadPool as Pool 12 | from collections import OrderedDict 13 | 14 | 15 | class _eachSchemeInfo(object): 16 | def __init__(self, schcode, schname): 17 | log.debug("Inside _eachSchemeInfo init") 18 | self.schcode = schcode 19 | self.schname = schname 20 | self.dateNav = OrderedDict() 21 | 22 | def addDateNav(self, datestring, nav): 23 | self.dateNav[datestring] = nav 24 | 25 | def printDateNav(self): 26 | print 27 | self.dateNav 28 | 29 | def getDateNav(self): 30 | return self.dateNav 31 | 32 | 33 | class _eachAMCsAllSchemeInfo(object): 34 | def __init__(self, amccode, amcname): 35 | log.debug("Inside _eachAMCsAllSchemeInfo init") 36 | self.amccode = amccode 37 | self.amcname = amcname 38 | self.schcodesandnames = {} 39 | self.schobjects = {} 40 | 41 | def addSchCodeAndName(self, schcode, schname, nav, datestring): 42 | self.schcodesandnames[schcode] = schname 43 | if schcode in self.schobjects.keys(): 44 | self.schobjects[schcode].addDateNav(datestring, nav) 45 | else: 46 | o = _eachSchemeInfo(schcode, schname) 47 | self.schobjects[schcode] = o 48 | o.addDateNav(datestring, nav) 49 | 50 | def getAMCCode(self): 51 | return self.amccode 52 | 53 | def getAMCName(self): 54 | return self.amcname 55 | 56 | def getAMCCodeAndName(self): 57 | return [self.getAMCCode(), self.getAMCName()] 58 | 59 | def isSchemePresent(self, schcode): 60 | return schcode in self.schcodesandnames.keys() 61 | 62 | def getSchCodeAndName(self): 63 | return self.schcodesandnames 64 | 65 | def printAllSchDetails(self, schcode=''): 66 | if schcode == '': 67 | for schcode, schobj in self.schobjects.keys(): 68 | print 69 | schcode 70 | print 71 | self.schcodesandnames[schcode] 72 | print 73 | schobj.printDateNav() 74 | else: 75 | o = self.schobjects[schcode] 76 | print 77 | schcode 78 | print 79 | self.schcodesandnames[schcode] 80 | print 81 | o.printDateNav() 82 | 83 | def getSchDetails(self, schcode): 84 | o = self.schobjects[schcode] 85 | return o.getDateNav() 86 | 87 | 88 | class MFDatabaseClass(object): 89 | def __init__(self, getallschdata=False, getHistoricNav=False, getamc=None, getsch=None): 90 | log.debug("Inside MFDatabaseClass init") 91 | self.__indexPositions = {} 92 | self.__startdate = START_DATE 93 | self.__today = datetime.today().strftime(DDMMMYYYY_FORMAT) 94 | self.__allData = {} 95 | 96 | if not os.path.exists(os.path.dirname(MFDB_FILENAME)): 97 | try: 98 | os.makedirs(os.path.dirname(MFDB_FILENAME)) 99 | except OSError as exc: # Guard against race condition 100 | if exc.errno != errno.EEXIST: 101 | raise 102 | if os.path.exists(MFDB_FILENAME): 103 | log.info("Reading data from " + MFDB_FILENAME) 104 | with open(MFDB_FILENAME, 'r') as f: 105 | r = csv.reader(f) 106 | for row in r: 107 | log.debug(row) 108 | self.__processEachRowData(row) 109 | 110 | if getallschdata: 111 | self.getAndUpdateAllSchemeData(getHistoricNav, getamc, getsch) 112 | 113 | def printAMCSchData(self, amc='', sch=''): 114 | if amc == '': 115 | for amccode, eachobj in self.__allData.items(): 116 | eachobj.printAllSchDetails(sch) 117 | else: 118 | self.__allData[amc].printAllSchDetails(sch) 119 | 120 | def getAMCSchData(self, amc=None, sch=None): 121 | if amc == None or sch == None: 122 | return self.__allData 123 | return self.__allData[amc].getSchDetails(sch) 124 | 125 | def getAMCSchCodeAndNames(self, amccode): 126 | return self.__allData[amccode].getSchCodeAndName() 127 | 128 | def getAndUpdateAllSchemeData(self, getforAmc=None, getforSch=None, getHistoricNav=False, getamc=None, getsch=None): 129 | pool = Pool(MAX_AMC_CODE_RANGE) 130 | for i in range(0, MAX_AMC_CODE_RANGE): 131 | pool.apply_async(self.__worker, (i, getforAmc, getforSch, getHistoricNav, getamc, getsch,)) 132 | pool.close() 133 | pool.join() 134 | 135 | log.info("Number of AMC's are : " + str(len(self.__allData))) 136 | if getforAmc is None and getforSch is None: 137 | with open(MFDB_FILENAME, mode='w') as f: 138 | log.info("Writing all the scheme info data to csv file") 139 | w = csv.writer(f) 140 | for amccode, eachobj in self.__allData.items(): 141 | log.debug("AMC Code:" + amccode + " AMC name :" + eachobj.getAMCName()) 142 | schcodeandname = eachobj.getSchCodeAndName() 143 | for code, name in schcodeandname.items(): 144 | log.debug("Schcode: " + code + " Sch Name: " + name) 145 | w.writerow([amccode, eachobj.getAMCName(), code, name]) 146 | else: 147 | log.info("Not writing all the scheme info data to csv file for now") 148 | 149 | def getAMCCodeForScheme(self, schcode): 150 | log.debug("Inside getAMCCodeForScheme") 151 | for amccode, eachobj in self.__allData.items(): 152 | schcodeandname = eachobj.getSchCodeAndName() 153 | for code, name in schcodeandname.items(): 154 | if code == schcode: 155 | log.debug(amccode) 156 | return amccode 157 | self.getAndUpdateAllSchemeData() 158 | for amccode, eachobj in self.__allData.items(): 159 | schcodeandname = eachobj.getSchCodeAndName() 160 | for code, name in schcodeandname.items(): 161 | if code == schcode: 162 | log.info(amccode) 163 | return amccode 164 | log.error("Could not get AMC code for the schcode: " + schcode) 165 | exit() 166 | 167 | def __worker(self, i, getforAmc, getforSch, getHistoricNav, getamc, getsch): 168 | schcodes = [] 169 | amccode = str(i) 170 | if ((getforAmc is not None) and (getforAmc != amccode)): 171 | return 172 | 173 | log.info("Trying to find if there is an AMC with the code " + amccode) 174 | fullurl = NAV_HISTORY_URL.format(amccode, self.__startdate, self.__today) 175 | log.info(fullurl) 176 | r = requests.get(fullurl) 177 | if r.status_code != 200: 178 | log.error(ERROR2_TEXT) 179 | exit() 180 | if 'text/plain' in r.headers.get('content-type'): 181 | amcname = re.findall(r".*Mutual Fund.*", r.text)[0].encode('ascii', 'ignore').strip('\r') 182 | log.info("There is an AMC with the code " + amccode + " name is " + amcname) 183 | pat = ".*;.*" 184 | foundheader = 0 185 | intrestedlines = re.findall(pat, r.text) 186 | for eachline in intrestedlines: 187 | line = eachline.encode('ascii', 'ignore').strip('\r') 188 | if foundheader != 4: 189 | for i in [SCHCODE_STRING, SCHNAME_STRING, NAV_STRING, DATE_STRING]: 190 | if i in line: 191 | indexpos = line.split(";").index(i) 192 | self.__indexPositions[i] = indexpos 193 | foundheader = foundheader + 1 194 | else: 195 | schc = line.split(";")[self.__indexPositions[SCHCODE_STRING]] 196 | schn = line.split(";")[self.__indexPositions[SCHNAME_STRING]] 197 | nav = line.split(";")[self.__indexPositions[NAV_STRING]] 198 | datestring = line.split(";")[self.__indexPositions[DATE_STRING]] 199 | if ((getforSch is not None) and (getforSch != schc)): 200 | continue 201 | if schc not in schcodes: 202 | schcodes.append(schc) 203 | if getHistoricNav: 204 | if ((getamc is not None) and (getsch is not None)): 205 | if ((getamc == amccode) and (getsch == schc)): 206 | self.__processEachRowData([amccode, amcname, schc, schn], [nav, datestring]) 207 | else: 208 | self.__processEachRowData([amccode, amcname, schc, schn], [nav, datestring]) 209 | 210 | log.info("Finished processing for AMC with the code " + amccode + " name is " + amcname) 211 | else: 212 | log.info("There is no AMC with the code " + amccode) 213 | 214 | def __processEachRowData(self, row, datenav=['', '']): 215 | amcc = row[0] 216 | amcn = row[1] 217 | schc = row[2] 218 | schn = row[3] 219 | nav = datenav[0] 220 | datestring = datenav[1] 221 | if amcc in self.__allData.keys(): 222 | amcobj = self.__allData[amcc] 223 | else: 224 | amcobj = _eachAMCsAllSchemeInfo(amcc, amcn) 225 | self.__allData[amcc] = amcobj 226 | amcobj.addSchCodeAndName(schc, schn, nav, datestring) 227 | -------------------------------------------------------------------------------- /mftracker/parseTransactionsClass.py: -------------------------------------------------------------------------------- 1 | from importlib import reload 2 | 3 | from .mflconst import * 4 | import requests 5 | import csv 6 | import re 7 | import io 8 | import os 9 | import errno 10 | from dateutil.parser import parse 11 | from re import sub 12 | from datetime import datetime, timedelta, date 13 | from multiprocessing.pool import ThreadPool as Pool 14 | from collections import OrderedDict 15 | import logging 16 | 17 | log = logging.getLogger(__name__) 18 | 19 | 20 | class _eachMFTransactionsData(object): 21 | def __init__(self, eachd, mfdb): 22 | self.mfdb = mfdb 23 | self.listOfTransactions = [] # date,type,price,units,amount 24 | self.listOfCumulativeData = [] # date,tunits,tamount 25 | self.ordTrans = OrderedDict() # date: type:price:units:amount 26 | self.cumulativeOrdTrans = OrderedDict() # "Date":"Type","Price","Units","Amount","Total Units","Total Amount","Total Value" 27 | self.cumulativeAllDatesData = OrderedDict() # "Date": "NAV","Total Units","Total Amount","Total Value" 28 | self.sortuniqdates = [] 29 | self.datenav = OrderedDict() # date: nav 30 | self.latestTaAndTv = [0, 0] # tu,tv 31 | self.goal = None 32 | self.add(eachd) 33 | 34 | def getListOfOrdTrans(self, tilld): 35 | retOrderTrans = OrderedDict() 36 | for d, v in self.ordTrans.items(): 37 | tilld_obj = datetime.strptime(tilld, DDMMMYYYY_FORMAT) 38 | # print d,tilld_obj 39 | if d < tilld_obj: 40 | retOrderTrans[d] = v 41 | elif d == tilld_obj: 42 | retOrderTrans[d] = v 43 | break 44 | else: 45 | break 46 | return retOrderTrans 47 | 48 | def resetLatestTaAndTv(self): 49 | self.latestTaAndTv = [0, 0] # tu,tv 50 | 51 | def getLatestTaAndTv(self, d): 52 | # latestTaAndTv = [0, 0] 53 | if d.strftime(DDMMMYYYY_FORMAT) in self.cumulativeAllDatesData.keys(): 54 | val = self.cumulativeAllDatesData[d.strftime(DDMMMYYYY_FORMAT)] 55 | ta = val[2] 56 | tv = val[3] 57 | self.latestTaAndTv = [ta, tv] 58 | return self.latestTaAndTv 59 | 60 | def processTransactions(self): 61 | self.calculateIfFundClosed() 62 | self.getFirstAndLastDate() 63 | self.mfcode = self.mfdb.getAMCCodeForScheme(self.schcode) 64 | 65 | def getTotalAmt1(self, TSU, buyList): 66 | ta = 0 67 | for s in buyList: 68 | d = s[0] 69 | t = s[1].strip() 70 | p = s[2] 71 | bu = s[3] 72 | a = s[4] 73 | if TSU <= bu: 74 | ta = ta + (TSU * p) 75 | return ta 76 | else: 77 | ta = ta + (bu * p) 78 | TSU = TSU - bu 79 | if TSU <= 1: 80 | return ta 81 | 82 | def getTotalAmt(self, TSU, buyList): 83 | ta = 0 84 | for s in buyList: 85 | d = s[0] 86 | t = s[1].strip() 87 | p = s[2] 88 | bu = s[3] 89 | a = s[4] 90 | 91 | if TSU > bu: 92 | TSU = TSU - bu 93 | ta = max(0,(round((ta + a), 4))) 94 | elif TSU <= bu: 95 | ta = max(0,(round((ta + (TSU * p)), 4))) 96 | break 97 | # if self.schcode == '102000': 98 | # print bu,TSU,ta,p 99 | # if self.schcode == '102000': 100 | # print bu, TSU, ta,p 101 | return ta 102 | 103 | def getCumulativeTransactionData(self): 104 | buyList = [] 105 | sellList = [] 106 | for d, key in self.ordTrans.items(): 107 | t = key[0] 108 | p = key[1] 109 | u = key[2] 110 | a = key[3] 111 | if t.lower() == "Buy".lower(): 112 | buyList.append([d, t, p, u, a]) 113 | else: 114 | sellList.append([d, t, p, u, a]) 115 | sTotalList = OrderedDict() 116 | TSU = 0 117 | for s in sellList: 118 | d = s[0] 119 | t = s[1].strip() 120 | p = s[2] 121 | u = s[3] 122 | a = s[4] 123 | TSU = TSU + u 124 | ta = self.getTotalAmt(TSU, buyList) 125 | sTotalList[d] = ta 126 | # try: 127 | # pv = sTotalList.values()[-1] 128 | # ta = ta - pv 129 | # sTotalList[d] = ta 130 | # except IndexError: 131 | # sTotalList[d] = ta 132 | newsTotalList = OrderedDict() 133 | for k, v in sTotalList.items(): 134 | i = list(sTotalList.keys()).index(k) 135 | if i != 0: 136 | sumv = list(sTotalList.values())[i - 1] 137 | else: 138 | sumv = 0 139 | retval = v - sumv 140 | newsTotalList[k] = retval 141 | 142 | tu = 0 143 | ta = 0 144 | for d, key in self.ordTrans.items(): 145 | t = key[0] 146 | p = key[1] 147 | u = key[2] 148 | a = key[3] 149 | if t.lower() == "Buy".lower(): 150 | tu = tu + u 151 | ta = ta + a 152 | else: 153 | tu = max(0,(tu - u)) 154 | ta = max(0,(ta - newsTotalList[d])) 155 | self.cumulativeOrdTrans[d] = [t, p, u, a, round(tu, 4), round(ta, 4), max(0,(round((tu * p), 4)))] 156 | 157 | def getCumulativeAllDatesData(self): 158 | row = None 159 | for d, n in self.datenav.items(): 160 | dobj = parse(d) 161 | if dobj in self.cumulativeOrdTrans.keys(): 162 | row = self.cumulativeOrdTrans[dobj] 163 | t = row[0] 164 | p = row[1] 165 | u = row[2] 166 | a = row[3] 167 | tu = row[4] 168 | ta = row[5] 169 | tv = row[6] 170 | self.cumulativeAllDatesData[d] = [n, tu, ta, tv] 171 | else: 172 | if row is None: 173 | self.cumulativeAllDatesData[d] = [n, 0, 0, 0] 174 | else: 175 | t = row[0] 176 | p = row[1] 177 | u = row[2] 178 | a = row[3] 179 | tu = row[4] 180 | ta = row[5] 181 | tv = row[6] 182 | self.cumulativeAllDatesData[d] = [n, tu, ta, max(0,(round((tu * float(n)), 4)))] 183 | self.calculateXIRR() 184 | 185 | def calculateXIRR(self): 186 | log.info("Calculating XIRR...") 187 | # print(self.cumulativeOrdTrans) 188 | for d, val in self.cumulativeAllDatesData.items(): 189 | tv = val[3] 190 | cashflows = [] 191 | for eachd, v in self.cumulativeOrdTrans.items(): 192 | dobj = parse(d) 193 | eachdobj = eachd 194 | if eachdobj <= dobj: 195 | t = v[0] 196 | amt = v[3] 197 | if t.lower() == 'Buy'.lower(): 198 | cashflows.append((eachdobj.date(), -amt)) 199 | else: 200 | cashflows.append((eachdobj.date(), amt)) 201 | cashflows.append((dobj.date(), tv)) 202 | # print cashflows 203 | cashflowsorted = sorted(cashflows, key=lambda x: x[0]) 204 | xirrval = xirr(cashflowsorted) 205 | # print d, xirrval 206 | xirrval_str = "{:.2%}".format(xirrval) 207 | self.cumulativeAllDatesData[d] = val + [xirrval_str] 208 | 209 | def getAmtToDeduct(self, sTotalList, d): 210 | out = 0 211 | for dd, v in sTotalList.items(): 212 | if dd == d: 213 | out = out + v 214 | break 215 | else: 216 | out = out - v 217 | return out 218 | 219 | def writeCumulativeToFile(self): 220 | log.debug("Inside writeCumulativeToFile") 221 | fname = SCH_PATH + format_filename(self.schname + self.schcode) + ".csv" 222 | if not os.path.exists(os.path.dirname(SCH_PATH)): 223 | try: 224 | os.makedirs(os.path.dirname(SCH_PATH)) 225 | except OSError as exc: # Guard against race condition 226 | if exc.errno != errno.EEXIST: 227 | raise 228 | if self.cumulativeAllDatesData: 229 | with open(fname, mode='w') as f: 230 | log.info("Writing all the sch info data to csv file " + self.schname) 231 | w = csv.writer(f) 232 | # w.writerow(["Date","Type","Price","Units","Amount","Total Units","Total Amount","Total Value"]) 233 | # for d, key in self.cumulativeOrdTrans.items(): 234 | # w.writerow([d.strftime(DDMMMYYYY_FORMAT)]+key) 235 | w.writerow(["Date", "NAV", "Total Units", "Total Amount", "Total Value", "XIRR"]) 236 | for d, key in self.cumulativeAllDatesData.items(): 237 | w.writerow([d] + key) 238 | 239 | def getNAVFomFirstToLastDates(self): 240 | self.navfilename = NAV_PATH + format_filename(self.schname + self.schcode) + ".csv" 241 | if not os.path.exists(os.path.dirname(NAV_PATH)): 242 | try: 243 | os.makedirs(os.path.dirname(NAV_PATH)) 244 | except OSError as exc: # Guard against race condition 245 | if exc.errno != errno.EEXIST: 246 | raise 247 | # If NAV csv is present 248 | # Read from csv 249 | if os.path.exists(self.navfilename): 250 | log.info("Reading data from " + self.navfilename) 251 | with open(self.navfilename, 'r') as f: 252 | r = csv.reader(f) 253 | self.datenav = OrderedDict(r) 254 | alldates = self.datenav.keys() 255 | datetimelist = [] 256 | for ed in alldates: 257 | datetimelist.append(parse(ed)) 258 | fd = min(datetimelist) 259 | ld = max(datetimelist) 260 | getd = False 261 | if fd != self.firstTransactionDate: 262 | f = self.firstTransactionDate 263 | l = self.lastDate 264 | getd = True 265 | if ld != self.lastDate: 266 | f = max(datetimelist) 267 | l = self.lastDate 268 | getd = True 269 | if fd != self.firstTransactionDate and ld != self.lastDate: 270 | f = self.firstTransactionDate 271 | l = self.lastDate 272 | if getd: 273 | self.getHistoricNavFromAmfi(f, l) 274 | else: 275 | self.getHistoricNavFromAmfi(self.firstTransactionDate, self.lastDate) 276 | 277 | if self.datenav: 278 | with open(self.navfilename, mode='w') as f: 279 | log.info("Writing all the nav info data to csv file " + self.schname) 280 | w = csv.writer(f) 281 | for d, n in self.datenav.items(): 282 | w.writerow([d, n]) 283 | 284 | def getHistoricNavFromAmfi(self, fd, ld): 285 | # Check the dates 286 | self.__indexPositions = {} 287 | log.info("Trying to get nav details from amfi for scheme " + self.schname + " " + self.schcode) 288 | url = NAV_HISTORY_URL.format(self.mfcode, fd.strftime(DDMMMYYYY_FORMAT), ld.strftime(DDMMMYYYY_FORMAT)) 289 | log.info(url) 290 | r = requests.get(url) 291 | if r.status_code != 200: 292 | log.error(ERROR2_TEXT) 293 | exit() 294 | if 'text/plain' in r.headers.get('content-type'): 295 | patschcode = ".*" + self.schcode + ";.*" 296 | pat = ".*;.*" 297 | foundheader = 0 298 | intrestedlines = re.findall(pat, r.text) 299 | for eachline in intrestedlines: 300 | #line = eachline.encode('ascii', 'ignore').strip('\r') 301 | line = eachline.strip('\r') 302 | if foundheader != 4: 303 | for i in [SCHCODE_STRING, SCHNAME_STRING, NAV_STRING, DATE_STRING]: 304 | if i in line: 305 | indexpos = line.split(";").index(i) 306 | self.__indexPositions[i] = indexpos 307 | foundheader = foundheader + 1 308 | else: 309 | break 310 | if foundheader == 4: 311 | intrestedlines = re.findall(patschcode, r.text) 312 | for eachline in intrestedlines: 313 | #line = eachline.encode('ascii', 'ignore').strip('\r') 314 | line = eachline.strip('\r') 315 | d = line.split(";")[self.__indexPositions[DATE_STRING]] 316 | n = line.split(";")[self.__indexPositions[NAV_STRING]] 317 | self.datenav[d] = n 318 | log.info("Done getting nav details from amfi for scheme " + self.schname + " " + self.schcode) 319 | 320 | def prepareOrderedDictTransactions(self): 321 | log.debug("Inside prepareOrderedDictTransactions") 322 | datetimelist = [] 323 | for lt in self.listOfTransactions: 324 | datetimelist.append(lt[0]) 325 | self.sortuniqdates = list(set(datetimelist)) 326 | self.sortuniqdates.sort() 327 | 328 | for eachdate in self.sortuniqdates: 329 | ltd = [] 330 | for lt in self.listOfTransactions: 331 | d = lt[0] 332 | if d == eachdate: 333 | ltd.append(lt) 334 | # log.info(ltd) 335 | if len(ltd) == 1: 336 | d = ltd[0][0] 337 | t = ltd[0][1] 338 | p = ltd[0][2] 339 | u = ltd[0][3] 340 | a = ltd[0][4] 341 | self.ordTrans[d] = [t, p, u, a] 342 | else: 343 | tu = 0 344 | ta = 0 345 | for eacht in ltd: 346 | d = eacht[0] 347 | t = eacht[1] 348 | p = eacht[2] 349 | u = eacht[3] 350 | a = eacht[4] 351 | if t.lower() == 'Buy'.lower(): 352 | tu = tu + float(u) 353 | ta = ta + float(a) 354 | else: 355 | tu = tu - float(u) 356 | ta = ta - float(a) 357 | if tu < 0: 358 | t = 'Sell' 359 | else: 360 | t = 'Buy' 361 | self.ordTrans[d] = [t, p, abs(tu), abs(ta)] 362 | 363 | def getFirstAndLastDate(self): 364 | datetimelist = [] 365 | for lt in self.listOfTransactions: 366 | datetimelist.append(lt[0]) 367 | self.firstTransactionDate = min(datetimelist) 368 | if self.fundClosed: 369 | self.lastDate = max(datetimelist) 370 | else: 371 | self.lastDate = datetime.today() 372 | 373 | # self.rangeOfActiveDates = [] 374 | # delta = self.lastDate - self.firstTransactionDate # timedelta 375 | # for i in range(delta.days + 1): 376 | # self.rangeOfActiveDates.append(self.firstTransactionDate + timedelta(i)) 377 | 378 | def calculateIfFundClosed(self): 379 | tunits = 0 380 | for lt in self.listOfTransactions: 381 | units = max(0,(round(lt[3], 4))) 382 | type = lt[1] 383 | if type.lower() == 'Buy'.lower(): 384 | tunits = tunits + units 385 | else: 386 | tunits = tunits - units 387 | self.tunits = abs(round(tunits, 4)) 388 | if tunits <= 0: 389 | self.fundClosed = True 390 | else: 391 | self.fundClosed = False 392 | 393 | def add(self, eachd): 394 | for k, v in eachd.items(): 395 | # key = k.encode('utf-8').strip() 396 | # val = v.encode('utf-8').strip() 397 | key = k.strip() 398 | val = v.strip() 399 | 400 | if TRANS_SCHCODE_STRING in key: 401 | self.schcode = val 402 | if TRANS_SCHNAME_STRING in key: 403 | self.schname = val 404 | if TRANS_EORD in key: 405 | self.eod = val 406 | if TRANS_GOAL in key: 407 | self.goal = val 408 | if "Date" in key: 409 | d = val 410 | dat = parse(d) 411 | if TRANS_TYPE in key: 412 | type = val 413 | if TRANS_PRICE in key: 414 | p = val 415 | # print p 416 | price = float(sub(r'[^\d.]', '', p)) 417 | if TRANS_UNITS in key: 418 | units = float(val) 419 | if TRANS_AMOUNT in key: 420 | a = val 421 | amt = float(sub(r'[^\d.]', '', a)) 422 | self.listOfTransactions.append([dat, type, price, units, amt]) 423 | 424 | def getlistOfTransactions(self): 425 | return self.listOfTransactions 426 | 427 | def getSchName(self): 428 | return self.schname 429 | 430 | def printDetails(self): 431 | print 432 | "MF/AMC Code: " + self.mfcode 433 | print 434 | "Scheme Code: " + self.schcode 435 | print 436 | "Scheme Name: " + self.getSchName() 437 | print 438 | "First Trans Date: " + str(self.firstTransactionDate) 439 | print 440 | "Last Date: " + str(self.lastDate) 441 | print 442 | "Fund Closed: " + str(self.fundClosed) 443 | print 444 | "Total Units: " + str(self.tunits) 445 | print 446 | "List of sortuniqdates: " 447 | print 448 | self.sortuniqdates 449 | print 450 | "List of transactions: " 451 | print 452 | self.getlistOfTransactions() 453 | print 454 | "List of ordered transactions: " 455 | print 456 | self.ordTrans 457 | print 458 | "List of cumulative ordered transactions: " 459 | print 460 | self.cumulativeOrdTrans 461 | print 462 | "List of cumulative all dates data: " 463 | print 464 | self.cumulativeAllDatesData 465 | print 466 | "List of date nav: " 467 | print 468 | self.datenav 469 | 470 | 471 | class parseTransactionsClass(object): 472 | def __init__(self, filename, mfdb): 473 | import sys 474 | reload(sys) 475 | #sys.setdefaultencoding('utf-8') 476 | 477 | 478 | self.allMFTransactionsObjs = {} 479 | log.info("Reading from the file " + filename) 480 | reader = csv.DictReader(io.open(filename, 'r')) 481 | dict_list = [] 482 | for line in reader: 483 | dict_list.append(line) 484 | log.debug("dict_list is..") 485 | log.debug(dict_list) 486 | # print dict_list 487 | for eachd in dict_list: 488 | for k, v in eachd.items(): 489 | #key = k.encode('utf-8').strip() 490 | #val = v.encode('utf-8').strip() 491 | key = k.strip() 492 | val = v.strip() 493 | # print key,val 494 | 495 | if TRANS_SCHCODE_STRING in key: 496 | if val in self.allMFTransactionsObjs.keys(): 497 | self.allMFTransactionsObjs[val].add(eachd) 498 | else: 499 | o = _eachMFTransactionsData(eachd, mfdb) 500 | self.allMFTransactionsObjs[val] = o 501 | 502 | pool = Pool(len(self.allMFTransactionsObjs)) 503 | for schcode, eachobj in self.allMFTransactionsObjs.items(): 504 | pool.apply_async(self.__worker0, (eachobj,)) 505 | pool.close() 506 | pool.join() 507 | 508 | ''' 509 | pool = Pool(len(self.allMFTransactionsObjs)) 510 | for schcode, eachobj in self.allMFTransactionsObjs.items(): 511 | pool.apply_async(self.__worker1, (eachobj,)) 512 | pool.close() 513 | pool.join() 514 | ''' 515 | for schcode, eachobj in self.allMFTransactionsObjs.items(): 516 | eachobj.processTransactions() 517 | eachobj.getNAVFomFirstToLastDates() 518 | eachobj.getCumulativeTransactionData() 519 | eachobj.getCumulativeAllDatesData() 520 | eachobj.writeCumulativeToFile() 521 | 522 | def __worker1(self, eachobj): 523 | eachobj.processTransactions() 524 | eachobj.getNAVFomFirstToLastDates() 525 | eachobj.getCumulativeTransactionData() 526 | eachobj.getCumulativeAllDatesData() 527 | eachobj.writeCumulativeToFile() 528 | 529 | def __worker0(self, eachobj): 530 | eachobj.prepareOrderedDictTransactions() 531 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------