Jupyter free installation

.github/workflows/no-optional-deps.yml

@@ -1,4 +1,5 @@
-name: Automated test suite wo/optional deps
+# Make sure we can install Jupyter notebook free environments
+name: Standalone install wo/optional deps test
 
 on:
   push:
@@ -18,22 +19,8 @@ jobs:
       uses: actions/setup-python@v4
       with:
         python-version: "3.12"
-    - name: Install Poetry
-      uses: snok/install-poetry@v1
-      with:
-        virtualenvs-create: true
-        virtualenvs-in-project: true
-        installer-parallel: true
-    - name: Load cached venv
-      id: cached-poetry-dependencies
-      uses: actions/cache@v2
-      with:
-        path: .venv
-        key: venv-${{ runner.os }}-${{ steps.setup-python.outputs.python-version }}-${{ hashFiles('**/poetry.lock') }}
-    - name: Install dependencies
-      if: steps.cached-poetry-dependencies.outputs.cache-hit != 'true'
-      run: |
-        poetry install --no-interaction
     - name: Run test scripts
       run: |
-        poetry run pytest -k test_no_opt_deps
+        bash scripts/standalone-test.sh
+      env:
+        TRADING_STRATEGY_API_KEY: ${{ secrets.TRADING_STRATEGY_API_KEY }}

CHANGELOG.md

@@ -1,6 +1,7 @@
-# Current
+# 0.24.3
 
-- TODO
+- Fix: Allow to run without Jupyter notebook/IPython installed. Make sure you use `Client.create_live_client()` instead of `Client.create_jupyter_client()`
+- Fix: Python version pindown `<3.13` instead of `<=3.12` as the pip did not allow minor versions like `3.12.7`
 
 # 0.24.2
 

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "trading-strategy"
-version = "0.24.1"
+version = "0.24.3"
 description = "Algorithmic trading data for cryptocurrencies and DEXes like Uniswap, Aave and PancakeSwap"
 authors = ["Mikko Ohtamaa <[email protected]>"]
 homepage = "https://tradingstrategy.ai"
@@ -34,7 +34,7 @@ Sponsor = "https://tradingstrategy.ai"
 [tool.poetry.dependencies]
 # Web3.py dependency compatibility
 # E.g. ethpm
-python = ">=3.10,<=3.12"
+python = ">=3.10,<3.13"
 dataclasses-json = "^0.5.4"
 pandas = "<3"
 # numpy.dtype size changed, may indicate binary incompatibility. Expected 96 from C header, got 88 from PyObject

scripts/standalone-test.sh

@@ -0,0 +1,29 @@
+#!/bin/bash
+#
+# See we can run without extra deps installed
+#
+
+if [[ -n "$VIRTUAL_ENV" ]]; then
+      echo "Error: A virtual environment is active. Cannot run."
+      exit 1
+fi
+
+set -e
+set -u
+
+CURRENT_PATH=`pwd`
+TEST_SCRIPT=$CURRENT_PATH/tests/standalone-check.py
+TEST_PATH=$(mktemp -d)
+
+cd $TEST_PATH
+
+python -m venv venv
+source venv/bin/activate
+pip install $CURRENT_PATH
+
+python $TEST_SCRIPT
+
+echo "All done"
+
+
+

tests/standalone-check.py

@@ -0,0 +1,51 @@
+"""A script to check that the package works with normal pip install without optional dependencies.
+
+- Will catch any import errors
+
+See scripts/standalone-test.sh
+"""
+
+print("Starting standalone check")
+
+import os
+
+import pandas as pd
+
+from tradingstrategy.chain import ChainId
+from tradingstrategy.client import Client
+from tradingstrategy.pair import PandasPairUniverse
+from tradingstrategy.timebucket import TimeBucket
+
+try:
+    import IPython
+    raise RuntimeError("IPython must not be installed for this script to run")
+except ImportError:
+    pass
+
+# Disable the settings file.
+# API key must be given in an environment variable.
+client = Client.create_live_client(
+    settings_path=None,
+    api_key=os.environ["TRADING_STRATEGY_API_KEY"],
+)
+# Load pairs in all exchange
+exchange_universe = client.fetch_exchange_universe()
+pairs_df = client.fetch_pair_universe().to_pandas()
+
+pair_universe = PandasPairUniverse(pairs_df, exchange_universe=exchange_universe)
+
+pair_ids = [
+    pair_universe.get_pair_by_human_description([ChainId.ethereum, "uniswap-v3", "WETH", "USDC", 0.0005]).pair_id,
+]
+
+start = pd.Timestamp.utcnow() - pd.Timedelta("3d")
+end = pd.Timestamp.utcnow()
+
+clmm_df = client.fetch_clmm_liquidity_provision_candles_by_pair_ids(
+    pair_ids,
+    TimeBucket.d1,
+    start_time=start,
+    end_time=end,
+)
+
+assert len(clmm_df) > 0

tests/test_client.py

@@ -2,11 +2,10 @@
 
 import os
 import logging
-from pathlib import Path
 
 import pytest
 
-from tradingstrategy.environment.jupyter import JupyterEnvironment, SettingsDisabled
+from tradingstrategy.environment.default_environment import DefaultClientEnvironment, SettingsDisabled
 from tradingstrategy.timebucket import TimeBucket
 from tradingstrategy.client import Client
 from tradingstrategy.chain import ChainId
@@ -134,7 +133,7 @@ def test_client_convert_all_pairs_to_pandas(client: Client, cache_path: str):
 
 def test_create_pyodide_client_detect():
     """Test the special client used in Pyodide which use HTTP referral authentication."""
-    env = JupyterEnvironment()
+    env = DefaultClientEnvironment()
     env.clear_configuration()
     client = Client.create_jupyter_client(pyodide=True)
 
@@ -162,6 +161,6 @@ def test_settings_disabled():
 
     client = Client.create_live_client(api_key=api_key, settings_path=None)
     env = client.env
-    assert isinstance(env, JupyterEnvironment)
+    assert isinstance(env, DefaultClientEnvironment)
     with pytest.raises(SettingsDisabled):
         env.setup_on_demand()

tradingstrategy/client.py

@@ -22,11 +22,11 @@
 import pandas as pd
 
 from tradingstrategy.candle import TradingPairDataAvailability
+from tradingstrategy.environment.default_environment import DefaultClientEnvironment, DEFAULT_SETTINGS_PATH
 from tradingstrategy.reader import BrokenData, read_parquet
 from tradingstrategy.top import TopPairsReply
 from tradingstrategy.transport.pyodide import PYODIDE_API_KEY
 from tradingstrategy.types import PrimaryKey, AnyTimestamp
-from tradingstrategy.utils.jupyter import is_pyodide
 from tradingstrategy.lending import LendingReserveUniverse, LendingCandleType, LendingCandleResult
 
 # TODO: Must be here because  warnings are very inconveniently triggered import time
@@ -50,10 +50,7 @@
 from tradingstrategy.chain import ChainId
 from tradingstrategy.environment.base import Environment, download_with_progress_plain
 from tradingstrategy.environment.config import Configuration
-from tradingstrategy.environment.jupyter import (
-    JupyterEnvironment,
-    download_with_tqdm_progress_bar, DEFAULT_SETTINGS_PATH,
-)
+
 from tradingstrategy.exchange import ExchangeUniverse
 from tradingstrategy.timebucket import TimeBucket
 from tradingstrategy.transport.cache import CachedHTTPTransport, DataNotAvailable
@@ -857,16 +854,21 @@ async def create_pyodide_client_async(cls,
         return cls.create_jupyter_client(cache_path, api_key, pyodide=True)
 
     @classmethod
-    def create_jupyter_client(cls,
-                              cache_path: Optional[str] = None,
-                              api_key: Optional[str] = None,
-                              pyodide=None,
-                              settings_path=DEFAULT_SETTINGS_PATH,
-                              ) -> "Client":
+    def create_jupyter_client(
+        cls,
+        cache_path: Optional[str] = None,
+        api_key: Optional[str] = None,
+        pyodide=None,
+        settings_path=DEFAULT_SETTINGS_PATH,
+    ) -> "Client":
         """Create a new API client.
 
         This function is intended to be used from Jupyter notebooks
 
+        .. note ::
+
+            Only use within Jupyter Notebook environments. Otherwise use :py:meth:`create_live_client`.
+
         - Any local or server-side IPython session
 
         - JupyterLite notebooks
@@ -890,11 +892,17 @@ def create_jupyter_client(cls,
 
         """
 
+        from tradingstrategy.transport.progress_enabled_download import download_with_tqdm_progress_bar
+
         if pyodide is None:
-            pyodide = is_pyodide()
+            try:
+                from tradingstrategy.utils.jupyter import is_pyodide
+                pyodide = is_pyodide()
+            except ImportError:
+                pyodide = False
 
         cls.preflight_check()
-        env = JupyterEnvironment(settings_path=settings_path)
+        env = DefaultClientEnvironment(settings_path=settings_path)
 
         # Try Pyodide default key
         if not api_key:
@@ -913,6 +921,7 @@ def create_jupyter_client(cls,
             api_key = config.api_key
 
         cache_path = cache_path or env.get_cache_path()
+
         transport = CachedHTTPTransport(
             download_with_tqdm_progress_bar,
             cache_path=cache_path,
@@ -929,6 +938,7 @@ def create_test_client(cls, cache_path=None) -> "Client":
         By default, the test client caches data under `/tmp` folder.
         Tests do not clear this folder between test runs, to make tests faster.
         """
+
         if cache_path:
             os.makedirs(cache_path, exist_ok=True)
         else:
@@ -937,7 +947,7 @@ def create_test_client(cls, cache_path=None) -> "Client":
         api_key = os.environ.get("TRADING_STRATEGY_API_KEY")
         assert api_key, "Unit test data client cannot be created without TRADING_STRATEGY_API_KEY env"
 
-        env = JupyterEnvironment(cache_path=cache_path, settings_path=None)
+        env = DefaultClientEnvironment(cache_path=cache_path, settings_path=None)
         config = Configuration(api_key=api_key)
         transport = CachedHTTPTransport(download_with_progress_plain, "https://tradingstrategy.ai/api", api_key=config.api_key, cache_path=env.get_cache_path(), timeout=15)
         return Client(env, transport)
@@ -953,7 +963,43 @@ def create_live_client(
 
         - The live client is non-interactive and logs using Python logger
 
-        - No interactive progress bars are set up
+        - If you want to run inside notebook, use :py:meth:`create_jupyter_client` instead
+
+        Example:
+
+        .. code-block:: python
+
+            from tradingstrategy.chain import ChainId
+            from tradingstrategy.client import Client
+            from tradingstrategy.pair import PandasPairUniverse
+            from tradingstrategy.timebucket import TimeBucket
+
+            # Disable the settings file.
+            # API key must be given in an environment variable.
+            client = Client.create_live_client(
+                settings_path=None,
+                api_key=os.environ["TRADING_STRATEGY_API_KEY"],
+            )
+            # Load pairs in all exchange
+            exchange_universe = client.fetch_exchange_universe()
+            pairs_df = client.fetch_pair_universe().to_pandas()
+
+            pair_universe = PandasPairUniverse(pairs_df, exchange_universe=exchange_universe)
+
+            pair_ids = [
+                pair_universe.get_pair_by_human_description([ChainId.ethereum, "uniswap-v3", "WETH", "USDC", 0.0005]).pair_id,
+            ]
+
+            start = pd.Timestamp.utcnow() - pd.Timedelta("3d")
+            end = pd.Timestamp.utcnow()
+
+            # Download some data
+            clmm_df = client.fetch_clmm_liquidity_provision_candles_by_pair_ids(
+                pair_ids,
+                TimeBucket.d1,
+                start_time=start,
+                end_time=end,
+            )
 
         :param api_key:
             Trading Strategy oracle API key, starts with `secret-token:tradingstrategy-...`
@@ -972,7 +1018,7 @@ def create_live_client(
         if settings_path is None:
             assert api_key, "Either API key or settings file must be given"
 
-        env = JupyterEnvironment(settings_path=settings_path)
+        env = DefaultClientEnvironment(settings_path=settings_path)
         if cache_path:
             cache_path = cache_path.as_posix()
         else:

tradingstrategy/environment/colab.py

@@ -1,8 +1,8 @@
 from tradingstrategy.environment.base import Environment
-from tradingstrategy.environment.jupyter import JupyterEnvironment
+from tradingstrategy.environment.jupyter import DefaultClientEnvironment
 
 
-class ColabEnvironment(JupyterEnvironment):
+class ColabEnvironment(DefaultClientEnvironment):
 
     def start(self):
         pass

tradingstrategy/environment/jupyter.py → tradingstrategy/environment/default_environment.py

@@ -1,4 +1,3 @@
-import functools
 import logging
 import os
 import platform
@@ -30,20 +29,26 @@
 DEFAULT_SETTINGS_PATH = Path(os.path.expanduser("~/.tradingstrategy"))
 
 
+
 class SettingsDisabled(Exception):
     """Raised when the user tries to create/read settings file when it is purposefully disabled.
 
     Docker environments.
     """
 
 
-class JupyterEnvironment(Environment):
-    """Define paths and setup processes when using Capitalgram from any local Jupyter Notebook installation"""
+class DefaultClientEnvironment(Environment):
+    """Sets up an application cache and settings.
+
+    - Use default `~/.cache` and `~/.tradingstrategy/settings.json` storage in your home folder.
+
+    - Locations can be overwritten e.g. in unit testes to temp paths
+    """
 
     def __init__(
         self,
         cache_path=None,
-        settings_path: Path | None = DEFAULT_SETTINGS_PATH,
+        settings_path=DEFAULT_SETTINGS_PATH,
     ):
         """CReate environment.