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

investfly_sdk-1.1/PKG-INFO

@@ -0,0 +1,175 @@
+Metadata-Version: 2.1
+Name: investfly-sdk
+Version: 1.1
+Summary: Investfly SDK
+Author-email: "Investfly.com" <admin@investfly.com>
+License: The MIT License (MIT)
+        
+        Copyright (c) 2023+ Investfly, Finverse LLC
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+Project-URL: Homepage, https://www.investfly.com
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE.txt
+Requires-Dist: certifi==2023.7.22
+Requires-Dist: charset-normalizer==3.2.0
+Requires-Dist: idna==3.4
+Requires-Dist: pandas==2.0.3
+Requires-Dist: pandas-stubs==2.0.3.230814
+Requires-Dist: pandas-ta==0.3.14b0
+Requires-Dist: python-dateutil==2.8.2
+Requires-Dist: pytz==2023.3
+Requires-Dist: requests==2.31.0
+Requires-Dist: types-requests==2.31.0.2
+Requires-Dist: six==1.16.0
+Requires-Dist: tzdata==2023.3
+Requires-Dist: urllib3==1.26.15
+Requires-Dist: numpy==1.26.4
+Requires-Dist: TA-Lib==0.4.28
+
+# About
+
+Python-SDK to work with Investfly API.
+[Investfly](https://www.investfly.com)
+
+Investfly offers a platform for developing automated stock trading strategies. Users can create trading strategies through an intuitive drag-and-drop interface or by coding in Python.
+
+The Investfly SDK contains the API and tools needed to build and deploy Python-based trading strategies on the Investfly platform.
+
+Although you can edit Python code in our browser-based editor, writing code in a familiar IDE (Pycharm, VSCode) is recommended due to all the benefits that rich IDE offers. This SDK and CLI that comes with it makes it possible to develop trading strategy locally using your favorite IDE and upload it your Investfly account.
+
+# Quickstart
+
+### SDK Installation and Setup
+
+Investfly-SDK comes with all required Python classes used for strategy development as well as a command line tool (CLI) called `investfly-cli`
+
+Using a terminal app, run the following commands.
+
+**Setup Project and Virtual Environment**
+
+```commandline
+mkdir investfly
+cd investfly
+python3 -m venv venv
+source venv/bin/activate
+```
+
+**Install investfly-sdk**
+
+```commandline
+pip install investfly-sdk
+```
+
+**Launch investfly-cli**
+
+Investfly SDK comes with a command line tool (CLI) called investfly-cli. 
+```commandline
+investfly-cli                                                                         
+
+investfly-cli$ -h
+usage: investfly-cli [-h] {login,logout,listStrategies,copySamples,exit} ...
+
+positional arguments:
+  {login,logout,listStrategies,copySamples,exit}
+                        Available Commands
+    login               Login to Investfly
+    logout              Logout from Investfly
+    listStrategies      List Python Strategies
+    copySamples         Copy Samples from SDK
+    ....
+    ....
+    exit                Stop and Exit CLI
+
+
+```
+
+**Test Installation**
+
+You can test the installation by using the CLI to login and logout of Investfly.
+```commandline
+investfly-cli$ login -u <YOUR_USERNAME> -p <YOUR_PASSWORD>
+Session(username='xxxxxx', clientId='xxxxx-kaj1p3lv', clientToken='b29c9acc-330a-4821-9187-282d827e3e91')
+
+investfly-cli$ logout
+```
+
+
+### Trading Strategy Development
+
+Investfly-SDK comes with a starter strategy template and many sample strategies to help you get started quickly.
+
+
+**Copy Samples**
+
+```commandline
+investfly-cli$ copySamples
+Samples copied to ./samples directory
+```
+
+**Create New Strategy**
+
+You can use one of the samples to create a new strategy. Normally, you would make a copy of the sample strategy, edit the copy using your favorite IDE to create a new strategy.
+But for now, we'll use the unmodified sample
+```commandline
+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
+Created strategy 83
+
+investfly-cli$ listStrategies
+{'strategyId': 83, 'strategyName': 'MySmaCrossOverStrategy'}
+
+```
+
+**Edit and Update Code**
+
+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
+Code Updated
+```
+
+After the code is updated, next step is to backtest the strategy and deploy it live. 
+You can do them by logging into Investfly with a web browser, navigating to the strategy page and invoking corresponding actions.
+
+
+### IDE Editor
+
+The primary reason for publishing this SDK is so that you can use your favorite IDE Editor to write and update Python Code.
+We recommend using PyCharm community edition:
+https://www.jetbrains.com/pycharm/download
+
+Using IDE editor will assist with auto-completion and type hints. Additionally, use type checking tools like mypy to check your code before deploying.
+
+When using the IDE, open `investfly` directory created above as a project with your IDE. 
+Make sure that Python Interpreter is configured to the virtual environment `investfly/venv/bin/python` created above.
+
+
+# Getting Help
+Please email [admin@investfly.com](admin@investfly.com) for any support or bug report
+
+
+

investfly_sdk-1.1/README.md

@@ -0,0 +1,126 @@
+# About
+
+Python-SDK to work with Investfly API.
+[Investfly](https://www.investfly.com)
+
+Investfly offers a platform for developing automated stock trading strategies. Users can create trading strategies through an intuitive drag-and-drop interface or by coding in Python.
+
+The Investfly SDK contains the API and tools needed to build and deploy Python-based trading strategies on the Investfly platform.
+
+Although you can edit Python code in our browser-based editor, writing code in a familiar IDE (Pycharm, VSCode) is recommended due to all the benefits that rich IDE offers. This SDK and CLI that comes with it makes it possible to develop trading strategy locally using your favorite IDE and upload it your Investfly account.
+
+# Quickstart
+
+### SDK Installation and Setup
+
+Investfly-SDK comes with all required Python classes used for strategy development as well as a command line tool (CLI) called `investfly-cli`
+
+Using a terminal app, run the following commands.
+
+**Setup Project and Virtual Environment**
+
+```commandline
+mkdir investfly
+cd investfly
+python3 -m venv venv
+source venv/bin/activate
+```
+
+**Install investfly-sdk**
+
+```commandline
+pip install investfly-sdk
+```
+
+**Launch investfly-cli**
+
+Investfly SDK comes with a command line tool (CLI) called investfly-cli. 
+```commandline
+investfly-cli                                                                         
+
+investfly-cli$ -h
+usage: investfly-cli [-h] {login,logout,listStrategies,copySamples,exit} ...
+
+positional arguments:
+  {login,logout,listStrategies,copySamples,exit}
+                        Available Commands
+    login               Login to Investfly
+    logout              Logout from Investfly
+    listStrategies      List Python Strategies
+    copySamples         Copy Samples from SDK
+    ....
+    ....
+    exit                Stop and Exit CLI
+
+
+```
+
+**Test Installation**
+
+You can test the installation by using the CLI to login and logout of Investfly.
+```commandline
+investfly-cli$ login -u <YOUR_USERNAME> -p <YOUR_PASSWORD>
+Session(username='xxxxxx', clientId='xxxxx-kaj1p3lv', clientToken='b29c9acc-330a-4821-9187-282d827e3e91')
+
+investfly-cli$ logout
+```
+
+
+### Trading Strategy Development
+
+Investfly-SDK comes with a starter strategy template and many sample strategies to help you get started quickly.
+
+
+**Copy Samples**
+
+```commandline
+investfly-cli$ copySamples
+Samples copied to ./samples directory
+```
+
+**Create New Strategy**
+
+You can use one of the samples to create a new strategy. Normally, you would make a copy of the sample strategy, edit the copy using your favorite IDE to create a new strategy.
+But for now, we'll use the unmodified sample
+```commandline
+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
+Created strategy 83
+
+investfly-cli$ listStrategies
+{'strategyId': 83, 'strategyName': 'MySmaCrossOverStrategy'}
+
+```
+
+**Edit and Update Code**
+
+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
+Code Updated
+```
+
+After the code is updated, next step is to backtest the strategy and deploy it live. 
+You can do them by logging into Investfly with a web browser, navigating to the strategy page and invoking corresponding actions.
+
+
+### IDE Editor
+
+The primary reason for publishing this SDK is so that you can use your favorite IDE Editor to write and update Python Code.
+We recommend using PyCharm community edition:
+https://www.jetbrains.com/pycharm/download
+
+Using IDE editor will assist with auto-completion and type hints. Additionally, use type checking tools like mypy to check your code before deploying.
+
+When using the IDE, open `investfly` directory created above as a project with your IDE. 
+Make sure that Python Interpreter is configured to the virtual environment `investfly/venv/bin/python` created above.
+
+
+# Getting Help
+Please email [admin@investfly.com](admin@investfly.com) for any support or bug report
+
+
+

investfly_sdk-1.1/investfly/__init__.py

@@ -0,0 +1,3 @@
+"""
+.. include:: ../README.md
+"""

investfly_sdk-1.1/investfly/api/InvestflyApiClient.py

@@ -0,0 +1,45 @@
+import datetime
+
+from investfly.api.MarketDataApiClient import MarketDataApiClient
+from investfly.api.PortfolioApiClient import PortfolioApiClient
+from investfly.api.RestApiClient import RestApiClient
+from investfly.api.StrategyApiClient import StrategyApiClient
+from investfly.models import Session
+
+
+class InvestflyApiClient:
+    """
+    Investfly API Client. This class should be used as the entry point to make all API calls.
+    After authentication, access marketApi or portfolioApi to make calls to /market or /portfolio endpoints
+    """
+
+    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 """
+        self.portfolioApi = PortfolioApiClient(self.restApiClient)
+        self.strategyApi = StrategyApiClient(self.restApiClient)
+
+    def login(self, username, password) -> Session:
+        """
+        Login to investfly backend.
+        :param username: Username
+        :param password: Password
+        :return: Session object representing authenticated session
+        """
+        return self.restApiClient.login(username, password)
+
+    def logout(self):
+        self.restApiClient.logout()
+
+    def isLoggedIn(self) -> bool:
+        return "investfly-client-id" in self.restApiClient.headers
+
+    def getSession(self) -> Session:
+        sessionJson = self.restApiClient.doGet('/user/session')
+        session: Session = Session.fromJsonDict(sessionJson)
+        return session
+
+    @staticmethod
+    def parseDatetime(date_str: str) -> datetime.datetime:
+        return datetime.datetime.strptime(date_str, '%Y-%m-%dT%H:%M:%S.%f%z')

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

@@ -30,8 +30,8 @@ class RestApiClient:
 
     def logout(self):
         requests.post(self.baseUrl + "/user/logout", verify=False)
-        self.clientId = None
-        self.clientToken = None
+        del self.headers['investfly-client-id']
+        del self.headers['investfly-client-token']
 
     def doGet(self, url: str) -> Any:
         res = requests.get(self.baseUrl + url, headers=self.headers, verify=False)

investfly_sdk-1.1/investfly/api/StrategyApiClient.py

@@ -0,0 +1,27 @@
+from typing import List, Any, Dict
+from investfly.api.RestApiClient import RestApiClient
+from investfly.models.StrategyModels import TradingStrategyModel
+
+
+class StrategyApiClient:
+
+    def __init__(self, restApiClient: RestApiClient) -> None:
+        self.restApiClient = restApiClient
+
+    def getStrategies(self) -> List[TradingStrategyModel]:
+        strategiesList: List[Dict[str, Any]] = self.restApiClient.doGet('/strategy/list')
+        strategiesList = list(filter(lambda jsonDict: jsonDict['type'] == 'CUSTOM', strategiesList))
+        return list(map(lambda jsonDict: TradingStrategyModel.fromDict(jsonDict), strategiesList))
+
+    def getStrategy(self, strategyId: int) -> TradingStrategyModel:
+        strategyDict = self.restApiClient.doGet('/strategy/' + str(strategyId))
+        return TradingStrategyModel.fromDict(strategyDict)
+
+    def createStrategy(self, strategyModel: TradingStrategyModel) -> TradingStrategyModel:
+        strategyDict = strategyModel.toDict()
+        strategyDict['type'] = 'CUSTOM'
+        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)

investfly_sdk-1.1/investfly/api/__init__.py

@@ -0,0 +1,3 @@
+""" This package contains REST API Client classes to make REST API calls to Investfly Backend.
+The entry point is `investfly.api.InvestflyApiClient`
+"""

investfly_sdk-1.1/investfly/cli/InvestflyCli.py

@@ -0,0 +1,194 @@
+import argparse
+import pickle
+import os.path
+from typing import List
+
+from investfly.api.InvestflyApiClient import InvestflyApiClient
+from investfly.models import Session
+from investfly.models.StrategyModels import TradingStrategyModel
+
+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 __listStrategies(self, args: argparse.Namespace) -> str:
+        strategies: List[TradingStrategyModel] = self.investflyApi.strategyApi.getStrategies()
+        strategiesDictList = list(map(lambda model: str({'strategyId': model.strategyId,  'strategyName': model.strategyName}), strategies))
+        return "\n".join(strategiesDictList)
+
+    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"
+
+    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 __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 __exitAction(self, args: argparse.Namespace|None) -> None:
+        if self.investflyApi.isLoggedIn():
+            self.investflyApi.logout()
+        self.running = False
+
+    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_listStrategies = subparser.add_parser('listStrategies', help='List Python Strategies')
+        parser_listStrategies.set_defaults(func=self.__listStrategies)
+
+        parser_copySamples = subparser.add_parser('copySamples', help='Copy Samples from SDK')
+        parser_copySamples.set_defaults(func=self.__copySamples)
+
+        parser_createStrategy = subparser.add_parser('createStrategy', 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_updateCode = subparser.add_parser('updateStrategyCode', 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='Python File Path relative to the project root that contains strategy code')
+        parser_updateCode.set_defaults(func=self.__updateCode)
+
+
+        parser_exit = subparser.add_parser('exit', help='Stop and Exit CLI')
+        parser_exit.set_defaults(func = self.__exitAction)
+
+        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()
+
+    # # Check to see if user already has a session active
+    # if os.path.exists('/tmp/loginSession'):
+    #     tmpfile = open('/tmp/loginSession', 'rb')
+    #     restApi = pickle.load(tmpfile)
+    #     tmpfile.close()
+    # else:
+    #     restApi = StrategyApiClient("https://api.investfly.com")
+    #
+    # # CLI Commands
+    # parser = argparse.ArgumentParser()
+    # subparser = parser.add_subparsers(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')
+    #
+    # subparser.add_parser('whoami', help='View your user information')
+    #
+    # subparser.add_parser('logout', help='Logout')
+    #
+    # parser_strategy = subparser.add_parser('strategy', help='View all your current strategies')
+    # parser_strategy.add_argument('-id', help='Provide the Strategy ID')
+    # parser_strategy.add_argument('-o', '--output-file', help='Provide a location to save the output file of a custom strategy (Requires Strategy ID)')
+    # parser_strategy.add_argument('-u', '--update-file', help='Provide the file location to update the script of a custom strategy (Requires Strategy ID)')
+    #
+    # args = parser.parse_args()
+    #
+    # # If user is logging in, create a new login session and save it locally
+    # if args.command == 'login':
+    #     restApi.login(args.username, args.password)
+    #     tmpFile = open('/tmp/loginSession', 'ab')
+    #     pickle.dump(restApi, tmpFile)
+    #     tmpFile.close()
+    #
+    # elif args.command == 'logout':
+    #     restApi.logout()
+    #     os.remove('/tmp/loginSession')
+    #
+    # elif args.command == 'whoami':
+    #     restApi.getStatus()
+    #
+    # elif args.command == 'strategy':
+    #     if all(e is None for e in [args.id, args.output_file, args.update_file]):
+    #         restApi.getStrategies()
+    #     elif (args.output_file is not None) and (args.id is not None):
+    #         try:
+    #             code = restApi.saveStrategy(args.id)
+    #             file = open(args.output_file, "w")
+    #             file.write(code)
+    #             file.close()
+    #             print('File successfully saved to '+args.output_file)
+    #         except Exception as e:
+    #             print(e)
+    #     elif (args.update_file is not None) and (args.id is not None):
+    #         try:
+    #             file = open(args.update_file, "r")
+    #             code = file.read()
+    #             restApi.updateStrategy(args.id, code)
+    #             file.close()
+    #         except Exception as e:
+    #             print(e)
+    #     else:
+    #         parser_strategy.print_help()
+    #
+    #
+    # else:
+    #     parser.print_help()
+
+
+if __name__ == '__main__':
+    #main()
+    print(inspect.getfile(samples))

{investfly_sdk-1.0 → investfly_sdk-1.1}/investfly/models/MarketDataIds.py

@@ -2,6 +2,7 @@ from enum import Enum
 
 
 class QuoteField(str, Enum):
+    """ Enum of all valid fields on Quote object """
     # ------ Quote ---
     LASTPRICE = "LASTPRICE"
     DAY_OPEN = "DAY_OPEN"

{investfly_sdk-1.0 → investfly_sdk-1.1}/investfly/models/StrategyModels.py

@@ -122,3 +122,25 @@ class DeploymentLog:
     def fromDict(json_dict: Dict[str, Any]) -> DeploymentLog:
         return DeploymentLog(ModelUtils.parseDatetime(json_dict['date']), LogLevel(json_dict['level']), json_dict['message'])
 
+class StandardOrCustom(str, Enum):
+    STANDARD = "STANDARD"
+    CUSTOM = "CUSTOM"
+
+@dataclass
+class TradingStrategyModel:
+    strategyName: str
+    strategyId: int | None = None
+    pythonCode: str | None = None
+    strategyDesc: str | None = None
+
+    @staticmethod
+    def fromDict(json_dict: Dict[str, Any]) -> TradingStrategyModel:
+        strategyId = json_dict['strategyId']
+        strategyName = json_dict['strategyName']
+        pythonCode = json_dict['pythonCode']
+        strategyDesc = json_dict.get('strategyDesc')
+        return TradingStrategyModel(strategyId=strategyId, strategyName=strategyName, pythonCode=pythonCode, strategyDesc=strategyDesc)
+
+    def toDict(self) -> Dict[str, Any]:
+        dict = self.__dict__.copy()
+        return dict

{investfly_sdk-1.0 → investfly_sdk-1.1}/investfly/samples/strategies/SmaCrossOverTemplate.py

@@ -12,7 +12,7 @@ from typing import Any, List, Dict
 import math
 import statistics
 import numpy as np
-import talib
+import talib  # https://pypi.org/project/TA-Lib/
 import pandas
 # ! WARN ! Imports other than listed above are disallowed and won't pass validation
 

investfly_sdk-1.1/investfly_sdk.egg-info/PKG-INFO

@@ -0,0 +1,175 @@
+Metadata-Version: 2.1
+Name: investfly-sdk
+Version: 1.1
+Summary: Investfly SDK
+Author-email: "Investfly.com" <admin@investfly.com>
+License: The MIT License (MIT)
+        
+        Copyright (c) 2023+ Investfly, Finverse LLC
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+Project-URL: Homepage, https://www.investfly.com
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE.txt
+Requires-Dist: certifi==2023.7.22
+Requires-Dist: charset-normalizer==3.2.0
+Requires-Dist: idna==3.4
+Requires-Dist: pandas==2.0.3
+Requires-Dist: pandas-stubs==2.0.3.230814
+Requires-Dist: pandas-ta==0.3.14b0
+Requires-Dist: python-dateutil==2.8.2
+Requires-Dist: pytz==2023.3
+Requires-Dist: requests==2.31.0
+Requires-Dist: types-requests==2.31.0.2
+Requires-Dist: six==1.16.0
+Requires-Dist: tzdata==2023.3
+Requires-Dist: urllib3==1.26.15
+Requires-Dist: numpy==1.26.4
+Requires-Dist: TA-Lib==0.4.28
+
+# About
+
+Python-SDK to work with Investfly API.
+[Investfly](https://www.investfly.com)
+
+Investfly offers a platform for developing automated stock trading strategies. Users can create trading strategies through an intuitive drag-and-drop interface or by coding in Python.
+
+The Investfly SDK contains the API and tools needed to build and deploy Python-based trading strategies on the Investfly platform.
+
+Although you can edit Python code in our browser-based editor, writing code in a familiar IDE (Pycharm, VSCode) is recommended due to all the benefits that rich IDE offers. This SDK and CLI that comes with it makes it possible to develop trading strategy locally using your favorite IDE and upload it your Investfly account.
+
+# Quickstart
+
+### SDK Installation and Setup
+
+Investfly-SDK comes with all required Python classes used for strategy development as well as a command line tool (CLI) called `investfly-cli`
+
+Using a terminal app, run the following commands.
+
+**Setup Project and Virtual Environment**
+
+```commandline
+mkdir investfly
+cd investfly
+python3 -m venv venv
+source venv/bin/activate
+```
+
+**Install investfly-sdk**
+
+```commandline
+pip install investfly-sdk
+```
+
+**Launch investfly-cli**
+
+Investfly SDK comes with a command line tool (CLI) called investfly-cli. 
+```commandline
+investfly-cli                                                                         
+
+investfly-cli$ -h
+usage: investfly-cli [-h] {login,logout,listStrategies,copySamples,exit} ...
+
+positional arguments:
+  {login,logout,listStrategies,copySamples,exit}
+                        Available Commands
+    login               Login to Investfly
+    logout              Logout from Investfly
+    listStrategies      List Python Strategies
+    copySamples         Copy Samples from SDK
+    ....
+    ....
+    exit                Stop and Exit CLI
+
+
+```
+
+**Test Installation**
+
+You can test the installation by using the CLI to login and logout of Investfly.
+```commandline
+investfly-cli$ login -u <YOUR_USERNAME> -p <YOUR_PASSWORD>
+Session(username='xxxxxx', clientId='xxxxx-kaj1p3lv', clientToken='b29c9acc-330a-4821-9187-282d827e3e91')
+
+investfly-cli$ logout
+```
+
+
+### Trading Strategy Development
+
+Investfly-SDK comes with a starter strategy template and many sample strategies to help you get started quickly.
+
+
+**Copy Samples**
+
+```commandline
+investfly-cli$ copySamples
+Samples copied to ./samples directory
+```
+
+**Create New Strategy**
+
+You can use one of the samples to create a new strategy. Normally, you would make a copy of the sample strategy, edit the copy using your favorite IDE to create a new strategy.
+But for now, we'll use the unmodified sample
+```commandline
+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
+Created strategy 83
+
+investfly-cli$ listStrategies
+{'strategyId': 83, 'strategyName': 'MySmaCrossOverStrategy'}
+
+```
+
+**Edit and Update Code**
+
+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
+Code Updated
+```
+
+After the code is updated, next step is to backtest the strategy and deploy it live. 
+You can do them by logging into Investfly with a web browser, navigating to the strategy page and invoking corresponding actions.
+
+
+### IDE Editor
+
+The primary reason for publishing this SDK is so that you can use your favorite IDE Editor to write and update Python Code.
+We recommend using PyCharm community edition:
+https://www.jetbrains.com/pycharm/download
+
+Using IDE editor will assist with auto-completion and type hints. Additionally, use type checking tools like mypy to check your code before deploying.
+
+When using the IDE, open `investfly` directory created above as a project with your IDE. 
+Make sure that Python Interpreter is configured to the virtual environment `investfly/venv/bin/python` created above.
+
+
+# Getting Help
+Please email [admin@investfly.com](admin@investfly.com) for any support or bug report
+
+
+

{investfly_sdk-1.0 → investfly_sdk-1.1}/investfly_sdk.egg-info/SOURCES.txt

@@ -6,10 +6,10 @@ investfly/api/InvestflyApiClient.py
 investfly/api/MarketDataApiClient.py
 investfly/api/PortfolioApiClient.py
 investfly/api/RestApiClient.py
+investfly/api/StrategyApiClient.py
 investfly/api/__init__.py
-investfly/cli/CliApiClient.py
+investfly/cli/InvestflyCli.py
 investfly/cli/__init__.py
-investfly/cli/commands.py
 investfly/models/CommonModels.py
 investfly/models/Indicator.py
 investfly/models/MarketData.py

investfly_sdk-1.1/investfly_sdk.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+investfly-cli = investfly.cli.InvestflyCli:main

{investfly_sdk-1.0 → investfly_sdk-1.1}/investfly_sdk.egg-info/requires.txt

@@ -12,3 +12,4 @@ six==1.16.0
 tzdata==2023.3
 urllib3==1.26.15
 numpy==1.26.4
+TA-Lib==0.4.28

{investfly_sdk-1.0 → investfly_sdk-1.1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "investfly-sdk"
-version = "1.0"
+version = "1.1"
 description = "Investfly SDK"
 authors = [
   { name = "Investfly.com", email = "admin@investfly.com" },
@@ -31,10 +31,11 @@ dependencies = [
     "six==1.16.0",
     "tzdata==2023.3",
     "urllib3==1.26.15",
-    "numpy==1.26.4"
+    "numpy==1.26.4",
+    "TA-Lib==0.4.28"
 ]
 [project.scripts]
-investfly-cli = "investfly.cli.commands:main"
+investfly-cli = "investfly.cli.InvestflyCli:main"
 
 [project.urls]
 Homepage = "https://www.investfly.com"

investfly_sdk-1.0/PKG-INFO

@@ -1,53 +0,0 @@
-Metadata-Version: 2.1
-Name: investfly-sdk
-Version: 1.0
-Summary: Investfly SDK
-Author-email: "Investfly.com" <admin@investfly.com>
-License: The MIT License (MIT)
-        
-        Copyright (c) 2023+ Investfly, Finverse LLC
-        
-        Permission is hereby granted, free of charge, to any person obtaining a copy
-        of this software and associated documentation files (the "Software"), to deal
-        in the Software without restriction, including without limitation the rights
-        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-        copies of the Software, and to permit persons to whom the Software is
-        furnished to do so, subject to the following conditions:
-        
-        The above copyright notice and this permission notice shall be included in all
-        copies or substantial portions of the Software.
-        
-        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-        SOFTWARE.
-Project-URL: Homepage, https://www.investfly.com
-Classifier: Programming Language :: Python :: 3
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Operating System :: OS Independent
-Requires-Python: >=3.7
-Description-Content-Type: text/markdown
-License-File: LICENSE.txt
-Requires-Dist: certifi==2023.7.22
-Requires-Dist: charset-normalizer==3.2.0
-Requires-Dist: idna==3.4
-Requires-Dist: pandas==2.0.3
-Requires-Dist: pandas-stubs==2.0.3.230814
-Requires-Dist: pandas-ta==0.3.14b0
-Requires-Dist: python-dateutil==2.8.2
-Requires-Dist: pytz==2023.3
-Requires-Dist: requests==2.31.0
-Requires-Dist: types-requests==2.31.0.2
-Requires-Dist: six==1.16.0
-Requires-Dist: tzdata==2023.3
-Requires-Dist: urllib3==1.26.15
-Requires-Dist: numpy==1.26.4
-
-# About
-
-Python-SDK to work with Investfly API.
-[Investfly](https://www.investfly.com)
-

investfly_sdk-1.0/README.md

@@ -1,5 +0,0 @@
-# About
-
-Python-SDK to work with Investfly API.
-[Investfly](https://www.investfly.com)
-

investfly_sdk-1.0/investfly/api/InvestflyApiClient.py

@@ -1,23 +0,0 @@
-import datetime
-
-from investfly.api.MarketDataApiClient import MarketDataApiClient
-from investfly.api.PortfolioApiClient import PortfolioApiClient
-from investfly.api.RestApiClient import RestApiClient
-
-
-class InvestflyApiClient:
-
-    def __init__(self, baseUrl: str = "https://api.investfly.com"):
-        self.restApiClient = RestApiClient(baseUrl)
-        self.marketApi = MarketDataApiClient(self.restApiClient)
-        self.portfolioApi = PortfolioApiClient(self.restApiClient)
-
-    def login(self, username, password):
-        return self.restApiClient.login(username, password)
-
-    def logout(self):
-        self.restApiClient.logout()
-
-    @staticmethod
-    def parseDatetime(date_str: str) -> datetime.datetime:
-        return datetime.datetime.strptime(date_str, '%Y-%m-%dT%H:%M:%S.%f%z')

investfly_sdk-1.0/investfly/cli/CliApiClient.py

@@ -1,46 +0,0 @@
-import requests
-from investfly.api.RestApiClient import RestApiClient
-
-class CliApiClient:
-
-    def __init__(self, baseUrl: str) -> None:
-        self.restApi = RestApiClient(baseUrl)
-
-    def login(self, username: str, password: str):
-        try: 
-            user = self.restApi.login(username, password)
-            print("Successfully logged in as: "+user.username)
-        except Exception as e:
-            print(e)
-    
-    def logout(self):
-        self.restApi.logout()
-
-    def getStatus(self):
-        try:
-            userInfo = self.restApi.doGet('/user/session')
-            print("Currently logged in as "+userInfo['username'])
-        except Exception as e:
-            print(e)
-
-    def getStrategies(self):
-        try:
-            strategies = self.restApi.doGet('/strategy/list')
-            for strategy in strategies:
-                print(str(strategy['strategyId'])+'\t'+strategy['strategyName']+'\n'+strategy['strategyDesc']+'\n')
-        except Exception as e:
-            print(e)
-
-    def saveStrategy(self, strategyId: int):
-        try:
-            strategy = self.restApi.doGet('/strategy/'+str(strategyId))
-            return strategy['pythonCode']
-        except Exception as e:
-            return e
-        
-    def updateStrategy(self, id: int, code: str):
-        try:
-            self.restApi.doPostCode('/strategy/'+id+'/update/code', code)
-            print('Strategy successfully updated')
-        except Exception as e:
-            print(e)

investfly_sdk-1.0/investfly/cli/commands.py

@@ -1,78 +0,0 @@
-import argparse
-import pickle
-import os.path
-
-from investfly.cli.CliApiClient import CliApiClient
-
-def main():
-    # Check to see if user already has a session active
-    if os.path.exists('/tmp/loginSession'):
-        tmpfile = open('/tmp/loginSession', 'rb')
-        restApi = pickle.load(tmpfile)
-        tmpfile.close()
-    else:
-        restApi = CliApiClient("https://api.investfly.com")
-
-    # CLI Commands
-    parser = argparse.ArgumentParser()
-    subparser = parser.add_subparsers(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')
-
-    subparser.add_parser('whoami', help='View your user information')
-
-    subparser.add_parser('logout', help='Logout')
-
-    parser_strategy = subparser.add_parser('strategy', help='View all your current strategies')
-    parser_strategy.add_argument('-id', help='Provide the Strategy ID')
-    parser_strategy.add_argument('-o', '--output-file', help='Provide a location to save the output file of a custom strategy (Requires Strategy ID)')
-    parser_strategy.add_argument('-u', '--update-file', help='Provide the file location to update the script of a custom strategy (Requires Strategy ID)')
-
-    args = parser.parse_args()
-
-    # If user is logging in, create a new login session and save it locally
-    if args.command == 'login':
-        restApi.login(args.username, args.password)
-        tmpFile = open('/tmp/loginSession', 'ab')
-        pickle.dump(restApi, tmpFile)
-        tmpFile.close()
-
-    elif args.command == 'logout':
-        restApi.logout()
-        os.remove('/tmp/loginSession')
-
-    elif args.command == 'whoami':
-        restApi.getStatus()
-
-    elif args.command == 'strategy':
-        if all(e is None for e in [args.id, args.output_file, args.update_file]):
-            restApi.getStrategies()
-        elif (args.output_file is not None) and (args.id is not None):
-            try:
-                code = restApi.saveStrategy(args.id)
-                file = open(args.output_file, "w")
-                file.write(code)
-                file.close()
-                print('File successfully saved to '+args.output_file)
-            except Exception as e:
-                print(e)
-        elif (args.update_file is not None) and (args.id is not None):
-            try:
-                file = open(args.update_file, "r")
-                code = file.read()
-                restApi.updateStrategy(args.id, code)
-                file.close()
-            except Exception as e:
-                print(e)
-        else:
-            parser_strategy.print_help()
-
-
-    else:
-        parser.print_help()
-
-
-if __name__ == '__main__':
-    main()

investfly_sdk-1.0/investfly_sdk.egg-info/PKG-INFO

@@ -1,53 +0,0 @@
-Metadata-Version: 2.1
-Name: investfly-sdk
-Version: 1.0
-Summary: Investfly SDK
-Author-email: "Investfly.com" <admin@investfly.com>
-License: The MIT License (MIT)
-        
-        Copyright (c) 2023+ Investfly, Finverse LLC
-        
-        Permission is hereby granted, free of charge, to any person obtaining a copy
-        of this software and associated documentation files (the "Software"), to deal
-        in the Software without restriction, including without limitation the rights
-        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-        copies of the Software, and to permit persons to whom the Software is
-        furnished to do so, subject to the following conditions:
-        
-        The above copyright notice and this permission notice shall be included in all
-        copies or substantial portions of the Software.
-        
-        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-        SOFTWARE.
-Project-URL: Homepage, https://www.investfly.com
-Classifier: Programming Language :: Python :: 3
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Operating System :: OS Independent
-Requires-Python: >=3.7
-Description-Content-Type: text/markdown
-License-File: LICENSE.txt
-Requires-Dist: certifi==2023.7.22
-Requires-Dist: charset-normalizer==3.2.0
-Requires-Dist: idna==3.4
-Requires-Dist: pandas==2.0.3
-Requires-Dist: pandas-stubs==2.0.3.230814
-Requires-Dist: pandas-ta==0.3.14b0
-Requires-Dist: python-dateutil==2.8.2
-Requires-Dist: pytz==2023.3
-Requires-Dist: requests==2.31.0
-Requires-Dist: types-requests==2.31.0.2
-Requires-Dist: six==1.16.0
-Requires-Dist: tzdata==2023.3
-Requires-Dist: urllib3==1.26.15
-Requires-Dist: numpy==1.26.4
-
-# About
-
-Python-SDK to work with Investfly API.
-[Investfly](https://www.investfly.com)
-

investfly_sdk-1.0/investfly_sdk.egg-info/entry_points.txt

@@ -1,2 +0,0 @@
-[console_scripts]
-investfly-cli = investfly.cli.commands:main