Metadata-Version: 2.1
Name: nepsense
Version: 0.0.3
Summary: Complete NepalStock solution in command line
Home-page: https://github.com/buddha231/NEPSENSE
Author: Buddha Gautam
Author-email: buddhagautam231@gmail.com
License: UNKNOWN
Description: 
        
        
        # NEPALSTONK
        Complete NEPSE solution in command line
        
        https://user-images.githubusercontent.com/52292457/123103383-a924c500-d455-11eb-94a4-b1fde8ff8c48.mp4
        ## Installation
        ```console
        pip install nepsense
        ````
        After the installation you can use the cli application with the priceof command
        
        ## Usage
        ```console
        usage: priceof [-h] [-c  [...]] [-f [path ...]] [-n] [-s] [-m symbol] [-ms] [-d] [-cu] [-ci] [--losers] [--gainers]
        [--supply] [--demand] [--turnover] [--volume] [--transactions]
        
        STONK, complete NEPSE solution in command line
        
        optional arguments:
          -h, --help            show this help message and exit
          -c  [ ...], --company  [ ...]
                                symbols of companies seperated by space
          -f [path ...], --floorsheet [path ...]
                                Saves today's floorsheet as a csv file You can specify the path as argument. if no argument 
                                is provided the csv file will be saved in the current directory
          -n, --nepse           get NEPSE index
          -s, --sub-indices     get subindices
          -m symbol, --market_depth symbol
                                get market depth of a company
          -ms, --market_summary
                                get market summary
          -d , --get_detail     get the non price related detail of the company
          -cu , --custom        custom list in data.py
          -ci , --change_index 
                                change the value of id sent as a payload in the post request
          --losers              get the top losers
          --gainers             get the top gainers
          --supply              get the scripts with maximum supply
          --demand              get the scripts with maximum demand
          --turnover            get the scripts with maximum turnover
          --volume              get the scripts with maximum volume
          --transactions        get the scripts with maximum transactions
        ```
        
        ## Please change the index with -ci flag.
        If you get this type of message when using the cli. Review the following video
        
        https://user-images.githubusercontent.com/52292457/123106754-a1b2eb00-d458-11eb-924c-591f24bcb4e2.mp4
        
        
        Since i can't afford to pay for the nepse api(I don't think I would, even if I could, but anyways). 
        There are some caveats to retrieving data from api endpoints from the nepse's newweb website. Nepse decided
        to change the request method for some api endpoints from get to post. The payload sent along with the
        post request changes randomly at different intervals. 
        The payload looks like 
        ```
        {
          "id" : 123
        }
        ```
        Here 123 is a random number. This number can be changed using the -ci flag. To get the id we have to 
        inspect the network traffic while loading the nepse's newweb website. This is demonstrated in the video above
        
        ## Floorsheet
        ```
        priceof -f [path]
        ```
        You can either specify a path or leave it blank. If you leave it blank the floorsheet csv file will be
        saved in you current directory. The floorsheet file will be saved as floorsheet_todaysdata_weekday.csv
        You can do different kind of analysis on the data using the floorsheet.ipynb notebook. 
        
        
Keywords: nepsense nepalstock stonk buddha python package buddha69
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3
Description-Content-Type: text/markdown
