investing-algorithm-framework 1.3.1__py3-none-any.whl → 7.25.6__py3-none-any.whl

investing_algorithm_framework/app/task.py

@@ -31,9 +31,11 @@ class Task:
         else:
             self.worker_id = self.__class__.__name__
 
-    def run(self, algorithm):
+    def run(self, context):
 
         if self.decorated:
-            self.decorated(algorithm=algorithm)
+            self.decorated(context=context)
         else:
-            raise NotImplementedError("Apply strategy is not implemented")
+            raise NotImplementedError(
+                "run method must be implemented in the subclass"
+            )

investing_algorithm_framework/app/web/__init__.py

@@ -1,4 +1,5 @@
 from .create_app import create_flask_app
 from .run_strategies import run_strategies
+from .schemas import OrderSerializer
 
-__all__ = ["create_flask_app", "run_strategies"]
+__all__ = ["create_flask_app", "run_strategies", 'OrderSerializer']

investing_algorithm_framework/app/web/controllers/__init__.py

@@ -1,7 +1,7 @@
-from investing_algorithm_framework.app.web.controllers.portfolio \
-    import blueprint as portfolio_blueprint
 from investing_algorithm_framework.app.web.controllers.orders import \
     blueprint as orders_blueprint
+from investing_algorithm_framework.app.web.controllers.portfolio \
+    import blueprint as portfolio_blueprint
 from investing_algorithm_framework.app.web.controllers.positions import \
     blueprint as positions_blueprint
 

investing_algorithm_framework/app/web/controllers/orders.py

@@ -1,13 +1,14 @@
 import logging
 
-from flask import Blueprint, request
 from dependency_injector.wiring import inject, Provide
-from investing_algorithm_framework.app.web.schemas import OrderSerializer
+from flask import Blueprint, request
+
 from investing_algorithm_framework.app.web.responses import create_response
+from investing_algorithm_framework.app.web.schemas import OrderSerializer
 from investing_algorithm_framework.dependency_container import \
     DependencyContainer
 
-logger = logging.getLogger(__name__)
+logger = logging.getLogger("investing_algorithm_framework")
 
 blueprint = Blueprint("order-views", __name__)
 

investing_algorithm_framework/app/web/controllers/portfolio.py

@@ -8,7 +8,7 @@ from investing_algorithm_framework.app.web.schemas import PortfolioSerializer
 from investing_algorithm_framework.dependency_container import \
     DependencyContainer
 
-logger = logging.getLogger(__name__)
+logger = logging.getLogger("investing_algorithm_framework")
 
 blueprint = Blueprint("portfolio-views", __name__)
 

investing_algorithm_framework/app/web/controllers/positions.py

@@ -1,12 +1,12 @@
 import logging
 
-from flask import Blueprint, request
 from dependency_injector.wiring import inject, Provide
+from flask import Blueprint, request
 
-from investing_algorithm_framework.app.web.schemas import PositionSerializer
 from investing_algorithm_framework.app.web.responses import create_response
+from investing_algorithm_framework.app.web.schemas import PositionSerializer
 
-logger = logging.getLogger(__name__)
+logger = logging.getLogger("investing_algorithm_framework")
 
 blueprint = Blueprint("position-views", __name__)
 

investing_algorithm_framework/app/web/create_app.py

@@ -5,10 +5,12 @@ from investing_algorithm_framework.app.web.setup_cors import setup_cors
 from .error_handler import setup_error_handler
 
 
-def create_flask_app(config):
+def create_flask_app(configuration_service):
     app = Flask(__name__.split('.')[0])
 
-    for key, value in config.items():
+    flask_config = configuration_service.get_flask_config()
+
+    for key, value in flask_config.items():
         app.config[key] = value
 
     app = setup_cors(app)

investing_algorithm_framework/app/web/error_handler.py

@@ -7,7 +7,7 @@ from werkzeug.exceptions import HTTPException
 
 from investing_algorithm_framework.domain import ApiException
 
-logger = logging.getLogger(__name__)
+logger = logging.getLogger("investing_algorithm_framework")
 
 
 def setup_error_handler(app) -> None:

investing_algorithm_framework/app/web/schemas/order.py

@@ -8,5 +8,5 @@ class OrderSerializer(Schema):
     price = fields.Float(dump_only=True)
     amount = fields.Float(dump_only=True)
     status = fields.String(dump_only=True)
-    type = fields.String(dump_only=True)
-    side = fields.String(dump_only=True)
+    order_type = fields.String(dump_only=True)
+    order_side = fields.String(dump_only=True)

investing_algorithm_framework/app/web/schemas/position.py

@@ -1,4 +1,5 @@
 from marshmallow import Schema, fields
+
 from investing_algorithm_framework.dependency_container import \
     DependencyContainer
 

investing_algorithm_framework/cli/cli.py

@@ -0,0 +1,231 @@
+import click
+
+from .deploy_to_aws_lambda import command as deploy_to_aws_lambda_command
+from .deploy_to_azure_function import command as \
+    deploy_to_azure_function_command
+from .initialize_app import command as initialize_app_command
+from .validate_backtest_checkpoints import command as \
+    validate_backtest_checkpoints_command
+
+"""
+CLI for Investing Algorithm Framework
+
+This module provides a command-line interface (CLI) for the
+Investing Algorithm Framework.
+"""
+
+
+@click.group()
+def cli():
+    """CLI for Investing Algorithm Framework"""
+    pass
+
+
+@click.command()
+@click.option(
+    '--type',
+    default="default",
+    help="Type of app to create. "
+    "Options are: 'default', 'default_web', 'azure_function', 'aws_lambda'."
+)
+@click.option(
+    '--path', default=None, help="Path to directory to initialize the app in"
+)
+@click.option(
+    '--replace',
+    is_flag=True,
+    default=False,
+    help="If True, duplicate files will be replaced."
+    "If False, files will not be replaced."
+)
+def init(type, path, replace):
+    """
+    Command-line tool for creating an app skeleton.
+
+    Args:
+        type (str): Type of app to create. Options are: 'default',
+            'default-web', 'azure-function'.
+        path (str): Path to directory to initialize the app in
+        replace (bool): If True, existing files will be replaced.
+            If False, existing files will not be replaced.
+
+    Returns:
+        None
+    """
+    initialize_app_command(path=path, app_type=type, replace=replace)
+
+
+@click.command()
+@click.option(
+    '--resource_group',
+    required=True,
+    help='The name of the resource group.',
+)
+@click.option(
+    '--subscription_id',
+    required=False,
+    help='The subscription ID. If not provided, the default will be used.'
+)
+@click.option(
+    '--storage_account_name',
+    required=False,
+    help='The name of the storage account.',
+)
+@click.option(
+    '--container_name',
+    required=False,
+    help='The name of the blob container.',
+    default='iafcontainer'
+)
+@click.option(
+    '--deployment_name',
+    required=True,
+    help='The name of the deployment. This will be" + \
+        "used as the name of the Function App.'
+)
+@click.option(
+    '--region',
+    required=True,
+    help='The Azure region for the resources.'
+)
+@click.option(
+    '--create_resource_group_if_not_exists',
+    is_flag=True,
+    help='Flag to create the resource group if it does not exist.'
+)
+@click.option(
+    '--skip_login',
+    is_flag=True,
+    help='Flag to create the resource group if it does not exist.',
+    default=False
+)
+def deploy_azure_function(
+    resource_group,
+    subscription_id,
+    storage_account_name,
+    container_name,
+    deployment_name,
+    region,
+    create_resource_group_if_not_exists,
+    skip_login
+):
+    """
+    Command-line tool for deploying a trading bot to Azure Function.
+
+    Args:
+        path (str): Path to directory to initialize the app in
+        resource_group (str): The name of the resource group.
+        subscription_id (str): The subscription ID. If not provided,
+            the default will be used.
+        storage_account_name (str): The name of the storage account.
+        container_name (str): The name of the blob container.
+        deployment_name (str): The name of the deployment. This will be
+            used as the name of the Function App.
+        region (str): The Azure region for the resources.
+        create_resource_group_if_not_exists (bool): Flag to create the
+            resource group if it does not exist.
+        skip_login (bool): Flag to skip the login process. This is
+            useful for CI/CD pipelines where the login is handled
+            separately.
+        region (str): The Azure region for the resources.
+        create_resource_group_if_not_exists (bool): Flag to create the
+            resource group if it does not exist.
+        skip_login (bool): Flag to skip the login process. This is
+            useful for CI/CD pipelines where the login is handled
+            separately.
+
+    Returns:
+        None
+    """
+    crg = create_resource_group_if_not_exists
+    deploy_to_azure_function_command(
+        resource_group=resource_group,
+        subscription_id=subscription_id,
+        storage_account_name=storage_account_name,
+        container_name=container_name,
+        deployment_name=deployment_name,
+        region=region,
+        create_resource_group_if_not_exists=crg,
+        skip_login=skip_login
+    )
+
+
+@click.command()
+@click.option(
+    '--lambda_function_name',
+    required=True,
+    help='The name of the AWS Lambda function to deploy.'
+)
+@click.option(
+    '--region',
+    required=True,
+    help='The AWS region where the Lambda function will be deployed.'
+)
+@click.option(
+    '--project_dir',
+    default=None,
+    help='The path to the project directory containing '
+         'the Lambda function code.'
+)
+@click.option(
+    '--memory_size',
+    default=3000,
+    type=int,
+    help='The memory size for the Lambda function in MB. Default is 3000 MB.'
+)
+@click.option(
+    '--env',
+    '-e',
+    multiple=True,
+    nargs=2,
+    type=str,
+    help='Environment variables to pass to the Lambda function. '
+         'Can be used multiple times: -e KEY VALUE -e KEY2 VALUE2'
+)
+def deploy_aws_lambda(
+    lambda_function_name,
+    region,
+    project_dir=None,
+    memory_size=3000,
+    env=None
+):
+    """
+    Command-line tool for deploying a trading bot to AWS lambda
+
+    Args:
+        lambda_function_name (str): The name of the AWS Lambda function
+            to deploy.
+        region (str): The AWS region where the Lambda function will
+            be deployed.
+        project_dir (str): The path to the project directory containing the
+            Lambda function code. If not provided, it defaults to
+            the current directory.
+        memory_size (int): The memory size for the Lambda function in MB.
+            Default is 3000 MB.
+        env (tuple): Environment variables as tuples of (KEY, VALUE).
+            Can be specified multiple times.
+
+    Returns:
+        None
+    """
+    # Convert env tuples to dictionary
+    env_vars = {}
+    if env:
+        for key, value in env:
+            env_vars[key] = value
+
+    deploy_to_aws_lambda_command(
+        lambda_function_name=lambda_function_name,
+        region=region,
+        project_dir=project_dir,
+        memory_size=memory_size,
+        env_vars=env_vars
+    )
+
+
+cli.add_command(init)
+cli.add_command(deploy_azure_function)
+cli.add_command(deploy_aws_lambda)
+cli.add_command(
+    validate_backtest_checkpoints_command, name="validate-checkpoints"
+)