Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
ltfdick1994 opened this issue Jan 31, 2023 · 1 comment
Open

Comments

@ltfdick1994
Copy link

ltfdick1994 commented Jan 31, 2023

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
Copy link
Contributor

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.

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

No branches or pull requests

2 participants