tradingstrategy-ai / docs

Trading strategy documentaiton
14 stars 9 forks source link

Quickstart instructions in README do not work out of the box #22

Open plamut opened 1 year ago

plamut commented 1 year ago

I tried building the repo locally as written in the README, but the operation(s) did not complete successfully.

I cloned a fresh copy of the repo, activated poetry shell, and ran the make command:

$ make   update-git-submodules   poetry-install   pip-force-install-deps   install-furo   rebuild-furo   clean-autosummary   clean   html

The command failed:

...
Submodule path 'deps/trade-executor/spec': checked out 'b9eabffc9782a9185297dc106c60564355906a5b'
Failed to recurse into submodule path 'deps/trade-executor/deps/web3-ethereum-defi'
Failed to recurse into submodule path 'deps/trade-executor'
Makefile:25: recipe for target 'update-git-submodules' failed
make: *** [update-git-submodules] Error 1

However, running the very same command again overcame the initial obstacle and started downloading/building the dependencies.

It still failed eventually at the last step, however:

...
Notebook error:
PandocMissing in programming/code-examples/candle-chart-example.ipynb:
Pandoc wasn't found.
Please check that pandoc is installed:
https://pandoc.org/installing.html
Makefile:61: recipe for target 'html' failed
make: *** [html] Error 2

It might be related to two early warnings emitted by autosummary:

WARNING: [autosummary] failed to import pandas_ta.statistics.quantily.
Possible hints:                                                                                                                                                                                                                                                                                                                                                                                                                   
* ImportError:                                                                                                                                                                                                                                                                                                                                                                                                                    
* AttributeError: module 'pandas_ta.statistics' has no attribute 'quantily'                                                                                                                                                                                                                                                                                                                                                       
* ModuleNotFoundError: No module named 'pandas_ta.statistics.quantily'   

...

WARNING: [autosummary] failed to import tradeexecutor.strategy.routing_model_base.
Possible hints:                                                                                                                                                                                                                                                                                                                                                                                                                   
* ImportError:                                                                                                                                                                                                                                                                                                                                                                                                                    
* ImportError: cannot import name 'EthereumRoutingStateBase' from 'tradeexecutor.ethereum.routing_state' (/home/peter/workspace/tradingstrategy/docs/deps/trade-executor/tradeexecutor/ethereum/routing_state.py)                                                                                                                                                                                                                 
* AttributeError: module 'tradeexecutor.strategy' has no attribute 'routing_model_base'