Command line tools optional

Author: lsbardel

.gitignore

@@ -27,6 +27,7 @@ dist
 .venv
 .mypy_cache
 .pytest_cache
+.ruff_cache
 .python-version
 
 # Jupyter

pyproject.toml

@@ -50,7 +50,7 @@ sympy = "^1.12"
 ipywidgets = "^8.0.7"
 
 [tool.poetry.scripts]
-qf = "quantflow.cli:main"
+qf = "quantflow.cli.script:main"
 
 [build-system]
 requires = ["poetry-core>=1.0.0"]

quantflow/cli/__init__.py

@@ -1,8 +0,0 @@
-try:
-    from .app import App
-except ImportError:
-    raise ImportError(
-        "Cannot run qf command line, " "quantflow needs to be installed with cli extras"
-    ) from None
-
-main = App()

quantflow/cli/app.py

@@ -1,7 +1,7 @@
 import asyncio
 import os
 from dataclasses import dataclass, field
-from typing import Any
+from typing import Any, Self
 
 import click
 import dotenv
@@ -29,12 +29,14 @@ def qf() -> None:
 
 @qf.command()
 @click.argument("symbol")
-def profile(symbol: str) -> None:
+@click.pass_context
+def profile(ctx: click.Context, symbol: str) -> None:
     """Company profile"""
+    app = QfApp.from_context(ctx)
     data = asyncio.run(get_profile(symbol))[0]
-    main.print(data.pop("description"))
+    app.print(data.pop("description"))
     df = pd.DataFrame(data.items(), columns=["Key", "Value"])
-    main.print(df_to_rich(df))
+    app.print(df_to_rich(df))
 
 
 @qf.command()
@@ -80,9 +82,13 @@ async def get_profile(symbol: str) -> list[dict]:
 
 
 @dataclass
-class App:
+class QfApp:
     console: Console = field(default_factory=Console)
 
+    @classmethod
+    def from_context(cls, ctx: click.Context) -> Self:
+        return ctx.obj  # type: ignore
+
     def __call__(self) -> None:
         os.makedirs(settings.SETTINGS_DIRECTORY, exist_ok=True)
         history = FileHistory(str(settings.HIST_FILE_PATH))
@@ -116,12 +122,12 @@ def handle_command(self, text: str) -> None:
         if not text:
             return
         elif text == "help":
-            return qf.main(["--help"], standalone_mode=False)
+            return qf.main(["--help"], standalone_mode=False, obj=self)
         elif text == "exit":
             raise click.Abort()
 
         try:
-            qf.main(text.split(), standalone_mode=False)
+            qf.main(text.split(), standalone_mode=False, obj=self)
         except click.exceptions.MissingParameter as e:
             self.error(e)
         except click.exceptions.NoSuchOption as e:

quantflow/cli/script.py

@@ -0,0 +1,10 @@
+try:
+    from .app import QfApp
+except ImportError:
+    raise ImportError(
+        "Cannot run qf command line, "
+        "quantflow needs to be installed with cli & data extras, "
+        "pip install quantflow[cli, data]"
+    ) from None
+
+main = QfApp()

readme.md

@@ -28,5 +28,10 @@ pip install quantflow
 
 ## Command line tools
 
-When installing with the extra `data` dependencies, it is possible to use the command line tool `qf`
+The command line tools are available when installing with the extra `cli` and `data` dependencies.
 
+```bash
+pip install quantflow[cli,data]
+```
+
+It is possible to use the command line tool `qf` to download data and run pricing and calibration scripts.