API doc update

tradingstrategy-ai · Oct 25, 2024 · 4e3fdbc · 4e3fdbc
1 parent 44f5b96
commit 4e3fdbc
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 10 deletions.
diff --git a/deps/trade-executor b/deps/trade-executor
diff --git a/source/deployment/repair.rst b/source/deployment/repair.rst
@@ -27,6 +27,15 @@ The reasons why a trade executor may mark a position as a frozen
 
 - Out of gas money
 
+Checking positions
+------------------
+
+You can check open/frozen/closed positions from the command line:
+
+.. code-block:: shell
+
+    docker compose run ethereum-memecoin-swing show-positions
+
 Fixing frozen positions
 -----------------------
 
@@ -41,26 +50,21 @@ Choose the trade executor Docker image version (you can peak the current version
 
 .. code-block:: shell
 
+    # Sets TRADE_EXECUTOR_VERSION environment variable needed for docker-compose.yml file
     source scripts/set-latest-tag.sh
 
-    # Or manualy:
-    # Tell docker-compose.yaml the pinned software version
-    # export TRADE_EXECUTOR_VERSION=v106
-
-    # Executor name for the following commmands
-    EXECUTOR_ID=quickswap-matic-usd-ema
-
 Check running strategies
 
 .. code-block:: shell
 
-    docker-compose ps
+    docker compose ps
 
 For any strategy to be repaired, its trade executor must be stopped first.
 
 .. code-block:: shell
 
-    docker-compose stop $EXECUTOR_ID
+    $EXECUTOR_ID=ethereum-memecoin-swing
+    docker compose stop $EXECUTOR_ID
 
 Now you can start the repair:
+1 −1		deps/trading-strategy
+1 −1		pyproject.toml
+1 −0		tests/cli/show-positions-long.json
+28 −0		tests/cli/test_cli_show_positions_long.py
+62 −0		tests/mainnet_fork/test_enzyme_credit_position.py
+31 −10		tradeexecutor/analysis/position.py
+189 −0		tradeexecutor/cli/commands/check_position_triggers.py
+23 −11		tradeexecutor/cli/commands/show_positions.py
+5 −1		tradeexecutor/cli/commands/start.py
+17 −5		tradeexecutor/cli/log.py
+2 −1		tradeexecutor/cli/main.py
+14 −3		tradeexecutor/ethereum/eth_valuation.py
+5 −7		tradeexecutor/strategy/execution_context.py
+5 −1		tradeexecutor/strategy/pandas_trader/decision_trigger.py
+3 −3		tradeexecutor/strategy/pandas_trader/indicator.py
+13 −13		tradeexecutor/strategy/runner.py
+12 −0		tradeexecutor/strategy/trading_strategy_universe.py
+1 −1		tradeexecutor/strategy/valuation.py