Skip to content

docs: add FXMacroData forex data example#1367

Draft
roberttidball wants to merge 1 commit into
kernc:masterfrom
roberttidball:agent/fxmacrodata-example
Draft

docs: add FXMacroData forex data example#1367
roberttidball wants to merge 1 commit into
kernc:masterfrom
roberttidball:agent/fxmacrodata-example

Conversation

@roberttidball

Copy link
Copy Markdown

Summary

  • add a Jupytext tutorial showing how to adapt FXMacroData daily FX spot rows into Backtesting.py OHLCV data
  • include a standard-library FXMacroData fetch helper using https://fxmacrodata.com/api/v1
  • link the generated example from the documentation tutorial index

Notes

  • The executed notebook cells use deterministic sample rows so docs builds do not depend on live network access or an API key.

Validation

  • .\.venv\Scripts\python.exe "doc\examples\FXMacroData Forex Data.py"
  • .\.venv\Scripts\jupytext.exe --test --to ipynb "doc\examples\FXMacroData Forex Data.py"
  • .\.venv\Scripts\python.exe -m py_compile "doc\examples\FXMacroData Forex Data.py" backtesting\__init__.py
  • git diff --cached --check
  • .\.venv\Scripts\python.exe -m unittest backtesting.test._test.TestDocs.test_examples (skipped on Windows by upstream guard)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant