investfly-sdk 1.1__tar.gz → 1.3__tar.gz

{investfly_sdk-1.1/investfly_sdk.egg-info → investfly_sdk-1.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: investfly-sdk
-Version: 1.1
+Version: 1.3
 Summary: Investfly SDK
 Author-email: "Investfly.com" <admin@investfly.com>
 License: The MIT License (MIT)
@@ -83,25 +83,40 @@ pip install investfly-sdk
 
 **Launch investfly-cli**
 
-Investfly SDK comes with a command line tool (CLI) called investfly-cli. 
+Install investfly-sdk also adds investfly-cli in your path inside the virtual environment. It can be launched simply by using `investfly-cli` command in the virtual env.
+
 ```commandline
-investfly-cli                                                                         
+(venv) user@host$ investfly-cli 
 
 investfly-cli$ -h
-usage: investfly-cli [-h] {login,logout,listStrategies,copySamples,exit} ...
+usage: investfly-cli [-h]
+                     {login,logout,strategy.list,strategy.copysamples,strategy.create,strategy.download,strategy.update,strategy.backtest.start,strategy.backtest.stop,strategy.backtest.result,exit}
+                     ...
 
 positional arguments:
-  {login,logout,listStrategies,copySamples,exit}
+  {login,logout,strategy.list,strategy.copysamples,strategy.create,strategy.download,strategy.update,strategy.backtest.start,strategy.backtest.stop,strategy.backtest.result,exit}
                         Available Commands
     login               Login to Investfly
     logout              Logout from Investfly
-    listStrategies      List Python Strategies
-    copySamples         Copy Samples from SDK
-    ....
-    ....
+    strategy.list       List Python Strategies
+    strategy.copysamples
+                        Copy Samples from SDK
+    strategy.create     Create a new trading strategy
+    strategy.download   Download one of your strategy and save it to a file
+    strategy.update     Update strategy Python Code
+    strategy.backtest.start
+                        Start backtest for strategy
+    strategy.backtest.stop
+                        Stop backtest for strategy
+    strategy.backtest.result
+                        Get backtest result, waiting if backtest is still
+                        running
     exit                Stop and Exit CLI
 
+options:
+  -h, --help            show this help message and exit
 
+investfly-cli$ 
 ```
 
 **Test Installation**
@@ -123,7 +138,7 @@ Investfly-SDK comes with a starter strategy template and many sample strategies
 **Copy Samples**
 
 ```commandline
-investfly-cli$ copySamples
+investfly-cli$ copysamples
 Samples copied to ./samples directory
 ```
 
@@ -135,10 +150,10 @@ But for now, we'll use the unmodified sample
 investfly-cli$ login -u <YOUR_USERNAME> -p <YOUR_PASSWORD>
 Session(username='xxxxx', clientId='xxxxxx-krfs61aa', clientToken='766fad47-3e1e-4f43-a77a-72a95a395fec')
 
-investfly-cli$ createStrategy -n MySmaCrossOverStrategy -f ./samples/strategies/SmaCrossOverStrategy.py
+investfly-cli$ strategy.create -n MySmaCrossOverStrategy -f ./samples/strategies/SmaCrossOverStrategy.py
 Created strategy 83
 
-investfly-cli$ listStrategies
+investfly-cli$ strategy.list
 {'strategyId': 83, 'strategyName': 'MySmaCrossOverStrategy'}
 
 ```
@@ -148,7 +163,7 @@ investfly-cli$ listStrategies
 Edit and update ./samples/strategies/SmaCrossOverStrategy.py as you like. For testing, change the `StandardSymbolsList.SP_100` to `StandardSymbolsList.SP_500` inside `getSecurityUniverseSelector` function.  
 
 ```commandline
-investfly-cli$ updateStrategyCode --id 83 -f ./samples/strategies/SmaCrossOverStrategy.py
+investfly-cli$ strategy.update --id 83 -f ./samples/strategies/SmaCrossOverStrategy.py
 Code Updated
 ```
 
@@ -168,6 +183,10 @@ When using the IDE, open `investfly` directory created above as a project with y
 Make sure that Python Interpreter is configured to the virtual environment `investfly/venv/bin/python` created above.
 
 
+# API Docs
+
+API Docs are published at https://www.investfly.com/guides/docs/index.html
+
 # Getting Help
 Please email [admin@investfly.com](admin@investfly.com) for any support or bug report
 

{investfly_sdk-1.1 → investfly_sdk-1.3}/README.md

@@ -34,25 +34,40 @@ pip install investfly-sdk
 
 **Launch investfly-cli**
 
-Investfly SDK comes with a command line tool (CLI) called investfly-cli. 
+Install investfly-sdk also adds investfly-cli in your path inside the virtual environment. It can be launched simply by using `investfly-cli` command in the virtual env.
+
 ```commandline
-investfly-cli                                                                         
+(venv) user@host$ investfly-cli 
 
 investfly-cli$ -h
-usage: investfly-cli [-h] {login,logout,listStrategies,copySamples,exit} ...
+usage: investfly-cli [-h]
+                     {login,logout,strategy.list,strategy.copysamples,strategy.create,strategy.download,strategy.update,strategy.backtest.start,strategy.backtest.stop,strategy.backtest.result,exit}
+                     ...
 
 positional arguments:
-  {login,logout,listStrategies,copySamples,exit}
+  {login,logout,strategy.list,strategy.copysamples,strategy.create,strategy.download,strategy.update,strategy.backtest.start,strategy.backtest.stop,strategy.backtest.result,exit}
                         Available Commands
     login               Login to Investfly
     logout              Logout from Investfly
-    listStrategies      List Python Strategies
-    copySamples         Copy Samples from SDK
-    ....
-    ....
+    strategy.list       List Python Strategies
+    strategy.copysamples
+                        Copy Samples from SDK
+    strategy.create     Create a new trading strategy
+    strategy.download   Download one of your strategy and save it to a file
+    strategy.update     Update strategy Python Code
+    strategy.backtest.start
+                        Start backtest for strategy
+    strategy.backtest.stop
+                        Stop backtest for strategy
+    strategy.backtest.result
+                        Get backtest result, waiting if backtest is still
+                        running
     exit                Stop and Exit CLI
 
+options:
+  -h, --help            show this help message and exit
 
+investfly-cli$ 
 ```
 
 **Test Installation**
@@ -74,7 +89,7 @@ Investfly-SDK comes with a starter strategy template and many sample strategies
 **Copy Samples**
 
 ```commandline
-investfly-cli$ copySamples
+investfly-cli$ copysamples
 Samples copied to ./samples directory
 ```
 
@@ -86,10 +101,10 @@ But for now, we'll use the unmodified sample
 investfly-cli$ login -u <YOUR_USERNAME> -p <YOUR_PASSWORD>
 Session(username='xxxxx', clientId='xxxxxx-krfs61aa', clientToken='766fad47-3e1e-4f43-a77a-72a95a395fec')
 
-investfly-cli$ createStrategy -n MySmaCrossOverStrategy -f ./samples/strategies/SmaCrossOverStrategy.py
+investfly-cli$ strategy.create -n MySmaCrossOverStrategy -f ./samples/strategies/SmaCrossOverStrategy.py
 Created strategy 83
 
-investfly-cli$ listStrategies
+investfly-cli$ strategy.list
 {'strategyId': 83, 'strategyName': 'MySmaCrossOverStrategy'}
 
 ```
@@ -99,7 +114,7 @@ investfly-cli$ listStrategies
 Edit and update ./samples/strategies/SmaCrossOverStrategy.py as you like. For testing, change the `StandardSymbolsList.SP_100` to `StandardSymbolsList.SP_500` inside `getSecurityUniverseSelector` function.  
 
 ```commandline
-investfly-cli$ updateStrategyCode --id 83 -f ./samples/strategies/SmaCrossOverStrategy.py
+investfly-cli$ strategy.update --id 83 -f ./samples/strategies/SmaCrossOverStrategy.py
 Code Updated
 ```
 
@@ -119,6 +134,10 @@ When using the IDE, open `investfly` directory created above as a project with y
 Make sure that Python Interpreter is configured to the virtual environment `investfly/venv/bin/python` created above.
 
 
+# API Docs
+
+API Docs are published at https://www.investfly.com/guides/docs/index.html
+
 # Getting Help
 Please email [admin@investfly.com](admin@investfly.com) for any support or bug report
 

investfly_sdk-1.3/investfly/__init__.py

@@ -0,0 +1,5 @@
+"""
+.. include:: ../README.md
+"""
+
+__all__ = ['api', 'models', 'utils']

investfly_sdk-1.3/investfly/api/IndicatorApiClient.py

@@ -0,0 +1,24 @@
+from typing import List, Dict, Any
+
+from investfly.api.RestApiClient import RestApiClient
+from investfly.models import IndicatorSpec
+
+
+class IndicatorApiClient:
+
+    def __init__(self, restApiClient: RestApiClient) -> None:
+        self.restApiClient = restApiClient
+
+    def listIndicators(self) -> List[IndicatorSpec]:
+        indicatorsListDict = self.restApiClient.doGet('/indicator/list/custom')
+        result: List[IndicatorSpec] = []
+        for indicatorDict in indicatorsListDict:
+            result.append(IndicatorSpec.fromDict(indicatorDict))
+        return result
+
+    def getIndicatorCode(self, indicatorId: str) -> str:
+        return self.restApiClient.doGet(f'/indicator/custom/{indicatorId}/code')
+
+    def createUpdateIndicator(self,  code: str) -> IndicatorSpec:
+        specDict: Dict[str, Any] = self.restApiClient.doPostCode('/indicator/custom/update', code)
+        return IndicatorSpec.fromDict(specDict)

{investfly_sdk-1.1 → investfly_sdk-1.3}/investfly/api/InvestflyApiClient.py

@@ -1,5 +1,6 @@
 import datetime
 
+from investfly.api.IndicatorApiClient import IndicatorApiClient
 from investfly.api.MarketDataApiClient import MarketDataApiClient
 from investfly.api.PortfolioApiClient import PortfolioApiClient
 from investfly.api.RestApiClient import RestApiClient
@@ -16,9 +17,12 @@ class InvestflyApiClient:
     def __init__(self, baseUrl: str = "https://api.investfly.com"):
         self.restApiClient = RestApiClient(baseUrl)
         self.marketApi = MarketDataApiClient(self.restApiClient)
-        """Class used to make calls to /market endpoint """
+        """Class used to make calls to /marketdata and /symbol endpoint to get market and symbol data"""
         self.portfolioApi = PortfolioApiClient(self.restApiClient)
+        """Class used to make calls to /portfolio endpoint to get portfolio and brokerage account data"""
         self.strategyApi = StrategyApiClient(self.restApiClient)
+        """Class used to make calls to /strategy endpoint to operate on trading strategies"""
+        self.indicatorApi = IndicatorApiClient(self.restApiClient)
 
     def login(self, username, password) -> Session:
         """

{investfly_sdk-1.1 → investfly_sdk-1.3}/investfly/api/MarketDataApiClient.py

@@ -4,6 +4,10 @@ from investfly.api.RestApiClient import RestApiClient
 
 
 class MarketDataApiClient:
+    """
+    MarketDataApiClient is intended to make calls to /marketdata and /symbol endpoint to get market and symbol data
+    from Investfly
+    """
 
     def __init__(self, restApiClient: RestApiClient) -> None:
         self.restApiClient = restApiClient

{investfly_sdk-1.1 → investfly_sdk-1.3}/investfly/api/PortfolioApiClient.py

@@ -6,6 +6,10 @@ from investfly.models.PortfolioModels import Broker, Portfolio, Balances, OpenPo
 
 
 class PortfolioApiClient:
+    """
+    This class is intended to make REST API calls to /portfolio endpoint to get information on virtual portfolio
+    and connected brokerage account
+    """
 
     def __init__(self, restApiClient: RestApiClient) -> None:
         self.restApiClient = restApiClient

{investfly_sdk-1.1 → investfly_sdk-1.3}/investfly/api/RestApiClient.py

@@ -12,6 +12,11 @@ warnings.simplefilter("ignore")
 
 class RestApiClient:
 
+    """
+    Internal class to make REST API requests. Users of the SDK do not use this class directly.
+    Please use investfly.api.InvestflyApiClient` instead
+    """
+
     def __init__(self, baseUrl: str) -> None:
         self.headers: Dict[str, str] = {}
         self.baseUrl = baseUrl

{investfly_sdk-1.1 → investfly_sdk-1.3}/investfly/api/StrategyApiClient.py

@@ -1,16 +1,21 @@
 from typing import List, Any, Dict
 from investfly.api.RestApiClient import RestApiClient
-from investfly.models.StrategyModels import TradingStrategyModel
+from investfly.models.CommonModels import Message
+from investfly.models.StrategyModels import TradingStrategyModel, BacktestResult
 
 
 class StrategyApiClient:
 
+    """
+    Class used to make calls to /strategy endpoint to operate on trading strategies.
+    """
+
     def __init__(self, restApiClient: RestApiClient) -> None:
         self.restApiClient = restApiClient
 
-    def getStrategies(self) -> List[TradingStrategyModel]:
+    def listStrategies(self) -> List[TradingStrategyModel]:
         strategiesList: List[Dict[str, Any]] = self.restApiClient.doGet('/strategy/list')
-        strategiesList = list(filter(lambda jsonDict: jsonDict['type'] == 'CUSTOM', strategiesList))
+        strategiesList = list(filter(lambda jsonDict: jsonDict['type'] == 'SCRIPT', strategiesList))
         return list(map(lambda jsonDict: TradingStrategyModel.fromDict(jsonDict), strategiesList))
 
     def getStrategy(self, strategyId: int) -> TradingStrategyModel:
@@ -19,9 +24,22 @@ class StrategyApiClient:
 
     def createStrategy(self, strategyModel: TradingStrategyModel) -> TradingStrategyModel:
         strategyDict = strategyModel.toDict()
-        strategyDict['type'] = 'CUSTOM'
+        strategyDict['type'] = 'SCRIPT'
         strategyDict = self.restApiClient.doPost('/strategy/create', strategyDict)
         return TradingStrategyModel.fromDict(strategyDict)
         
     def updateStrategyCode(self, strategyId: int, code: str) -> str:
-        return self.restApiClient.doPostCode('/strategy/' + str(strategyId) + '/update/code', code)
+        return self.restApiClient.doPostCode('/strategy/' + str(strategyId) + '/update/code', code)
+
+    def startBacktest(self, strategyId: int) -> Message:
+        message = self.restApiClient.doPost(f'/backtest/{strategyId}/start', {})
+        return Message.fromDict(message)
+
+    def stopBacktest(self, strategyId: int) -> Message:
+        message = self.restApiClient.doPost(f'/backtest/{strategyId}/stop', {})
+        return Message.fromDict(message)
+
+    def getBacktestResult(self, strategyId: int) -> BacktestResult:
+        resultDict: Dict[str, Any] = self.restApiClient.doGet(f'/backtest/{strategyId}/result')
+        return BacktestResult.fromDict(resultDict)
+

investfly_sdk-1.3/investfly/api/__init__.py

@@ -0,0 +1,17 @@
+""" This package contains REST API Client classes to make REST API calls to Investfly server.
+The entry point is `investfly.api.InvestflyApiClient`
+
+InvestflyApiClient has members to access specific endpoints such as strategyApi, portfolioApi etc
+
+For now, only those API methods that are commonly used during in strategy development are added in the clients.
+
+```
+from investfly.api.InvestflyApiClient import InvestflyApiClient
+api = InvestflyApiClient()
+api.login("<YOUR USERNAME>", "<YOUR PASSWORD>")
+pythonStrategies = api.strategyApi.getStrategies()
+print(pythonStrategies)
+api.logout()
+```
+
+"""

investfly_sdk-1.3/investfly/cli/InvestflyCli.py

@@ -0,0 +1,218 @@
+import argparse
+import pickle
+import os.path
+import time
+from typing import List, cast
+
+from investfly.api.InvestflyApiClient import InvestflyApiClient
+from investfly.models import Session, IndicatorSpec
+from investfly.models.StrategyModels import TradingStrategyModel, BacktestResult, BacktestStatus, BacktestResultStatus
+
+from investfly import samples
+import inspect
+from pathlib import Path
+import shutil
+
+
+class InvestflyCli:
+
+    def __init__(self):
+        self.running: bool = True
+        self.investflyApi = InvestflyApiClient()
+
+
+    def __loginAction(self, args: argparse.Namespace) -> Session:
+        username = args.username
+        password = args.password
+        session = self.investflyApi.login(username, password)
+        return session
+
+    def __logoutAction(self, args: argparse.Namespace) -> None:
+        self.investflyApi.logout()
+
+    def __exitAction(self, args: argparse.Namespace|None) -> None:
+        if self.investflyApi.isLoggedIn():
+            self.investflyApi.logout()
+        self.running = False
+
+    def __copySamples(self, args: argparse.Namespace) -> str:
+        samplesPath = inspect.getfile(samples)
+        path = Path(samplesPath)
+        parentPath = path.parent
+        shutil.copytree(parentPath, './samples', dirs_exist_ok=True)
+        return "Samples copied to ./samples directory"
+
+
+    # ==== Strategy Command Handlers
+
+    def __listStrategies(self, args: argparse.Namespace) -> str:
+        strategies: List[TradingStrategyModel] = self.investflyApi.strategyApi.listStrategies()
+        strategiesDictList = list(map(lambda model: str({'strategyId': model.strategyId,  'strategyName': model.strategyName}), strategies))
+        return "\n".join(strategiesDictList)
+
+    def __createStrategy(self, args: argparse.Namespace) -> str:
+        name = args.name
+        path = args.file
+        with open(path, 'r') as source_file:
+            code = source_file.read()
+        tradingStrategyModel = TradingStrategyModel(strategyName=name, strategyDesc=name, pythonCode=code)
+        tradingStrategyModel = self.investflyApi.strategyApi.createStrategy(tradingStrategyModel)
+        return f'Created strategy {tradingStrategyModel.strategyId}'
+
+    def __downloadCode(self, args: argparse.Namespace) -> str:
+        strategyId = int(args.id)
+        path = args.file
+        strategyModel: TradingStrategyModel = self.investflyApi.strategyApi.getStrategy(strategyId)
+        code: str = cast(str, strategyModel.pythonCode)
+        with open(path, 'w') as out_file:
+            out_file.write(code)
+        return f"Strategy saved to {path}"
+
+    def __updateCode(self, args: argparse.Namespace) -> str:
+        strategyId = int(args.id)
+        path = args.file
+        with open(path, 'r') as source_file:
+            code = source_file.read()
+        self.investflyApi.strategyApi.updateStrategyCode(strategyId, code)
+        return 'Code Updated'
+
+    def __startBacktest(self, args: argparse.Namespace) -> str:
+        strategyId = int(args.id)
+        message = self.investflyApi.strategyApi.startBacktest(strategyId)
+        return str(message.toDict())
+
+    def __stopBacktest(self, args: argparse.Namespace) -> str:
+        strategyId = int(args.id)
+        message = self.investflyApi.strategyApi.stopBacktest(strategyId)
+        return str(message.toDict())
+
+    def __pollResults(self, args: argparse.Namespace) -> str:
+        strategyId = int(args.id)
+        backtestResult: BacktestResult = self.investflyApi.strategyApi.getBacktestResult(strategyId)
+        backtestStatus: BacktestResultStatus = backtestResult.status
+        print(str(backtestStatus.toDict()))
+        notFinished = backtestStatus.jobStatus == BacktestStatus.QUEUED or backtestStatus.jobStatus == BacktestStatus.INITIALIZING or backtestStatus.jobStatus == BacktestStatus.RUNNING
+        try:
+            while notFinished:
+                time.sleep(3)
+                backtestResult = self.investflyApi.strategyApi.getBacktestResult(strategyId)
+                backtestStatus = backtestResult.status
+                print(str(backtestStatus.toDict()))
+                notFinished = backtestStatus.jobStatus == BacktestStatus.QUEUED or backtestStatus.jobStatus == BacktestStatus.INITIALIZING or backtestStatus.jobStatus == BacktestStatus.RUNNING
+        except KeyboardInterrupt as e:
+            print("Interrupted")
+            pass
+        return str(backtestResult.performance)
+
+    # ==== INDICATOR COMMAND HANDLERS
+
+    def __listIndicators(self, args: argparse.Namespace) -> str:
+        indicators: List[IndicatorSpec] = self.investflyApi.indicatorApi.listIndicators()
+        idList = list(map(lambda spec: spec.indicatorId, indicators))
+        return str(idList)
+
+    def __createUpdateIndicator(self, args: argparse.Namespace):
+        path = args.file
+        with open(path, 'r') as source_file:
+            code = source_file.read()
+        self.investflyApi.indicatorApi.createUpdateIndicator(code)
+
+    def __downloadIndicatorCode(self, args: argparse.Namespace):
+        indicatorId = args.id
+        path = args.file
+        code = self.investflyApi.indicatorApi.getIndicatorCode(indicatorId)
+        with open(path, 'w') as out_file:
+            out_file.write(code)
+        return f"Indicator saved to {path}"
+
+    def runCli(self) -> None:
+        parser = argparse.ArgumentParser(prog="investfly-cli")
+        subparser = parser.add_subparsers(help='Available Commands', dest="command")
+
+        parser_login = subparser.add_parser('login', help='Login to Investfly')
+        parser_login.add_argument('-u', '--username', required=True, help='Input username')
+        parser_login.add_argument('-p', '--password', required=True, help='Input user password')
+        parser_login.set_defaults(func=self.__loginAction)
+
+        parser_logout = subparser.add_parser('logout', help="Logout from Investfly")
+        parser_logout.set_defaults(func=self.__logoutAction)
+
+        parser_copySamples = subparser.add_parser('copysamples', help='Copy Strategy and Indicator Samples from SDK')
+        parser_copySamples.set_defaults(func=self.__copySamples)
+
+        parser_exit = subparser.add_parser('exit', help='Stop and Exit CLI')
+        parser_exit.set_defaults(func = self.__exitAction)
+
+        # ======= STRATEGY COMMANDS ==========
+
+        parser_listStrategies = subparser.add_parser('strategy.list', help='List Python Strategies')
+        parser_listStrategies.set_defaults(func=self.__listStrategies)
+
+        parser_createStrategy = subparser.add_parser('strategy.create', help='Create a new trading strategy')
+        parser_createStrategy.add_argument('-n', '--name', required=True, help='Strategy Name')
+        parser_createStrategy.add_argument('-f', '--file', required=True, help='Python File Path relative to the project root that contains strategy code')
+        parser_createStrategy.set_defaults(func=self.__createStrategy)
+
+        parser_downloadStrategy = subparser.add_parser('strategy.download', help='Download one of your strategy python code and save it to a file')
+        parser_downloadStrategy.add_argument('-i', '--id', required=True, help='Strategy ID')
+        parser_downloadStrategy.add_argument('-f', '--file', required=True, help='File path (with file name) to save strategy python code')
+        parser_downloadStrategy.set_defaults(func=self.__downloadCode)
+
+        parser_updateCode = subparser.add_parser('strategy.update', help='Update strategy Python Code')
+        parser_updateCode.add_argument('-i', '--id', required=True, help='Strategy ID')
+        parser_updateCode.add_argument('-f', '--file', required=True, help='File path (with file name) that contains strategy code')
+        parser_updateCode.set_defaults(func=self.__updateCode)
+
+        parser_startBacktest = subparser.add_parser('strategy.backtest.start', help='Start backtest for strategy')
+        parser_startBacktest.add_argument('-i', '--id', required=True, help='Strategy ID')
+        parser_startBacktest.set_defaults(func=self.__startBacktest)
+
+        parser_stopBacktest = subparser.add_parser('strategy.backtest.stop', help='Stop backtest for strategy')
+        parser_stopBacktest.add_argument('-i', '--id', required=True, help='Strategy ID')
+        parser_stopBacktest.set_defaults(func=self.__stopBacktest)
+
+        parser_resultBacktest = subparser.add_parser('strategy.backtest.result', help='Get backtest result, waiting if backtest is still running')
+        parser_resultBacktest.add_argument('-i', '--id', required=True, help='Strategy ID')
+        parser_resultBacktest.set_defaults(func=self.__pollResults)
+
+        # ====== INDICATOR COMMANDS ====
+
+        parser_listIndicators = subparser.add_parser('indicator.list', help='List Custom Indicators')
+        parser_listIndicators.set_defaults(func=self.__listIndicators)
+
+        parser_downloadIndicator = subparser.add_parser('indicator.download', help='Download indicator python code and save it to a file')
+        parser_downloadIndicator.add_argument('-i', '--id', required=True, help='IndicatorId ID')
+        parser_downloadIndicator.add_argument('-f', '--file', required=True,  help='File path (with file name) to save indicator python code')
+        parser_downloadIndicator.set_defaults(func=self.__downloadIndicatorCode)
+
+        parser_createUpdateIndicator = subparser.add_parser('indicator.update', help='Create or update indicator. Indicator ID is retried from ClassName')
+        parser_createUpdateIndicator.add_argument('-f', '--file', required=True, help='File path (with file name) that contains indicator code')
+        parser_createUpdateIndicator.set_defaults(func=self.__createUpdateIndicator)
+
+        while self.running:
+            try:
+                data = input("\ninvestfly-cli$ ")
+                args = parser.parse_args(data.split())
+                if args.command is None:
+                    # When user hits Enter without any command
+                    parser.print_help()
+                else:
+                    result = args.func(args)
+                    if result is not None:
+                        print(result)
+            except SystemExit:
+                # System exit is caught because when -h is used, argparser displays help and exists the apputils with SystemExit
+                pass
+            except KeyboardInterrupt:
+                self.__exitAction(None)
+            except Exception as e:
+                print("Received exception " + str(e))
+
+
+
+def main():
+    investflyCli = InvestflyCli()
+    investflyCli.runCli()
+
+if __name__ == '__main__':
+    main()

{investfly_sdk-1.1 → investfly_sdk-1.3}/investfly/models/CommonModels.py

@@ -10,6 +10,9 @@ from investfly.models.ModelUtils import ModelUtils
 
 @dataclass
 class DatedValue:
+    """
+    Data Container class to hold Time,Value for timed numeric values
+    """
     date: datetime
     value: float | int
 
@@ -25,6 +28,11 @@ class DatedValue:
 
 
 class TimeUnit(str, Enum):
+
+    """
+    TimeUnit Enum (MINUTES, HOURS, DAYS)
+    """
+
     MINUTES = "MINUTES"
     HOURS = "HOURS"
     DAYS = "DAYS"
@@ -38,6 +46,7 @@ class TimeUnit(str, Enum):
 
 @dataclass
 class TimeDelta:
+    """ TimeDelta container class similar to python timedelta """
     value: int
     unit: TimeUnit
 
@@ -58,9 +67,31 @@ class TimeDelta:
         return TimeDelta(json_dict['value'], TimeUnit[json_dict['unit']])
 
 
+class MessageType(str, Enum):
+    ERROR = "ERROR"
+    SUCCESS = "SUCCESS"
+    WARN = "WARN"
+
+@dataclass
+class Message:
+    type: MessageType
+    message: str
+
+    def toDict(self) -> Dict[str, Any]:
+        return self.__dict__.copy()
+
+    @staticmethod
+    def fromDict(json_dict: Dict[str, Any]) -> Message:
+        return Message(MessageType[json_dict['type']], json_dict['message'])
+
+
+
 
 @dataclass
 class Session:
+
+    """ Class that represents logged in user session with the Investfly server """
+
     username: str
     clientId: str
     clientToken: str