Name		Name	Last commit message	Last commit date
parent directory ..
_static		_static
_templates		_templates
.gitignore		.gitignore
00_quick_start.ipynb		00_quick_start.ipynb
01_connecting.ipynb		01_connecting.ipynb
02_historical_data.ipynb		02_historical_data.ipynb
03_streaming_market_data.ipynb		03_streaming_market_data.ipynb
04_data_tables.ipynb		04_data_tables.ipynb
05_market_orders.ipynb		05_market_orders.ipynb
06_entry_orders.ipynb		06_entry_orders.ipynb
07_fxcm_order.ipynb		07_fxcm_order.ipynb
08_oco_orders.ipynb		08_oco_orders.ipynb
Makefile		Makefile
README.md		README.md
Test_fxcmAPI.ipynb		Test_fxcmAPI.ipynb
appendix.rst		appendix.rst
conf.py		conf.py
fxcm_log_cfg		fxcm_log_cfg
index.rst		index.rst
layout.html		layout.html

README.md

`fxcmpy` Documentation

This is the Git repository containing the files of the documentation for the fxcmpy Python wrapper package.

First, make sure to have the required Python packages installed as well as Sphinx with the Notebook extension nbsphinx:

pip install numpy pandas matplotlib ipython jupyter
pip install sphinx nbsphinx

To build the documentation locally, first clone the repository then navigate to the folder of the repository and execute the build file:

git clone https://github.com/fxcm/fxcmpy-doc.git
cd fxcmpy-doc
make html

The build files are then found in _build/html.

The Python Quants GmbH | [email protected]