Metadata-Version: 2.1
Name: lakshmi
Version: 1.0.1
Summary: Investing Tools.
Home-page: https://github.com/sarvjeets/lakshmi
Author: Sarvjeet Singh
Author-email: sarvjeet@gmail.com
License: UNKNOWN
Description: # Lakshmi
        
        ## Introduction
        This project is inspired by all the time I spent on
        [Bogleheads forum](bogleheads.org). The forum taught me to focus on important
        things like asset allocation, location and minimizing costs. The focus is on
        simple but [powerful philosophy](https://www.bogleheads.org/wiki/Bogleheads%C2%AE_investment_philosophy)
        that allows investors to acheive above-average
        returns after costs. This tool is build around the same priciples to help
        an _average_ investor manage their investing portfolio.
        
        ## Installation
        
        To install the library and the lak command line tool, run:
        ```
        pip install lakshmi
        ```
        
        ## Command-line interface
        
        (This is a quick-start guide. You may find a detailed description of
        the tool [here](docs/lak.md))
        
        The simplest way to use this project is via the **lak** command. To access the
        upto help, run:
        
        ```
        lak --help
        
        Usage: lak [OPTIONS] COMMAND [ARGS]...
        
        Options:
          --version      Show the version and exit.
          -r, --refresh  Re-fetch all data instead of using previously cached data.
                         For large portfolios this would be extremely slow.
          --help         Show this message and exit.
        
        Commands:
          add      Add new accounts or assets to the portfolio.
          analyze  Analyze the portfolio.
          delete   Delete an account or asset.
          edit     Edit parts of the portfolio.
          info     Prints detailed information about an asset or account.
          init     Initializes a new portfolio by adding asset classes.
          list     Command to list various parts of the portfolio.
          whatif   Run hypothetical what if scenarios by adding DELTA to an...
        ```
        
        A new portfolio can be created by either:
        1. Copying an [existing](data/portfolio.yaml) (TODO: Add file) portfolio file to 
        ~/portfolio.yaml and editing it.
        
        -- OR --
        
        2. Using the lak commands to create a new portfolio. The following command will
        open up an editor to input the desired asset allocation:
        ```
        lak init
        ```
        
        To view help for the init command, please run:
        ```
        lak init --help
        ```
        
        Accounts (His/Her 401(k), Roth IRAs, Taxable, etc.) can be added via
        the **lak add account** command:
        ```
        lak add account
        ```
        Assets can be added to the account via the **lak add asset** command:
        ```
        lak add asset -p TickerAsset -t account_str
        ```
        where account_str is a sub-string that uniquely matches an account added previously.
        
        That's it. To view all the assets, asset allocation and asset location, run:
        ```
        lak list assets 
        lak list total
        list list aa
        lak list al
        ```
        The **lak list** commands can also be chained:
        ```
        lak list assets total aa al
        ```
        
        [TODO: Detailed Description of the tool](docs/lak.md)
        
        ## Library
        
        TODO: Add details about the lakshmi module.
        
        ## Dedication
        
        I would like to thank my wife [Niharika](http://niharika.org), who encouraged me to
        start working on this package and supported me throughout the development.
        This project would not have been possible without her love and support.
        
        In addition, I am indebted to the following folks whose wisdom has helped me
        tremendously in my investing journey:
        [John Bogle](https://en.wikipedia.org/wiki/John_C._Bogle),
        [Taylor Larimore](https://www.bogleheads.org/wiki/Taylor_Larimore),
        [Nisiprius](https://www.bogleheads.org/forum/viewtopic.php?t=242756),
        [Livesoft](https://www.bogleheads.org/forum/viewtopic.php?t=237269),
        [Mel Lindauer](https://www.bogleheads.org/wiki/Mel_Lindauer) and
        [LadyGeek](https://www.bogleheads.org/blog/2018/12/04/interview-with-ladygeek-bogleheads-site-administrator/).
        
Platform: any
Requires-Python: >=3.9.5
Description-Content-Type: text/markdown
