Metadata-Version: 2.1
Name: pyportfoliotracker
Version: 0.0.1
Summary: Track the performance of your portfolio of equities vs an index
Home-page: https://github.com/bryan-teng/portfolio-tracker
Author: Bryan Teng
Author-email: teng.weiyan.bryan@gmail.com
License: UNKNOWN
Description: # portfolio-tracker
        Track an equity portfolio's performance against a major index.
        
        ## 1. Setting up your fund
        
        Under main.py, set up your fund using the following parameters:
        
        `fund = Fund(cash, index_ticker, date_of_creation, strategy):`
        
        where
        - cash = cash value of the fund
        - index_ticker = the ticker (based on Yahoo Finance) of the benchmark index
        - date_of_creation = date of creation of the fund
        - strategy (optional) = strategy used for the index benchmark. The default strategy is lump_sum.
        
        ## 2. Purchasing the relevant equities
        
        Using the .buy_equity() method, purchase the relevant equities that are present in your fund.
        
        `fund.buy_equity(ticker, date_of_purchase, qty, price)`
        
        where
        - ticker = the ticker (based on Yahoo Finance) of the equity
        - date_of_purchase = date of purchase of the equity
        - qty = quantity of equity purchased
        - price = price at which equity was purchased
        
        ## 3. Selecting your desired output
        
        There are 2 types of output that can be obtained:
        
        **1. Graphical comparison of fund vs index performance** : obtained by calling `fund.plot_fund_performance()`
        
        **2. CSV file containing the value of the fund vs index over time** : obtained by calling `fund.export_to_csv(output_path)`
        
        Note that the variable `output_path` in `.export_to_csv` is set to 'data/historical-paper-values.csv' by default.
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
