cuemacro / finmarketpy

Python library for backtesting trading strategies & analyzing financial markets (formerly pythalesians)
http://www.cuemacro.com
Apache License 2.0
3.41k stars 490 forks source link

Where is the api documentation? How are we supposed to use it? #43

Open ltfdick1994 opened 1 year ago

ltfdick1994 commented 1 year ago

Doesn't even see a list of functions/methods to be used, let alone a basic documentation. and I have googled around and there just isn't any documentation of this library. How can we use it without the most basic understanding of the library? You have to at least create a documentation page and list out all the classes and functions right?

saeedamen commented 1 year ago

There is a full folder full of examples at https://github.com/cuemacro/finmarketpy/tree/master/finmarketpy_examples, and another folder with Jupyter notebooks at https://github.com/cuemacro/finmarketpy/tree/master/finmarketpy_examples/finmarketpy_notebooks illustrating use cases eg. developing a systematic trading strategy, how to download data etc. I would recommend having a look at these to get you started. Every method/class also have docstrings. I can also run workshops for any firms who want to use my libraries.

Of course I would like there to be more documentation, but unfortunately, I am the only major contributor as no one else has volunteered.