search

westonplatter / fast_arrow

(no longer maintained) A simple yet robust (stock+options) API client for Robinhood
MIT License
127 stars 37 forks source link

A little help for the ignorant folks like myself #76

Closed AmeliorateOr closed 5 years ago

AmeliorateOr commented 5 years ago

What's your feature? Description with example on how to get this code running. I've looked through and tried to use the examples but I can't interpret it effectively.

Why are you interested in it being added? I am not skilled at programming by any means and barely understand the basics. This looks like it can do quite a bit and I'm very interested in using it.

That said, I have no idea how to utilize these scripts and what variables to fill in, etc, etc. Could you create some type of basic information "how-to", to get me started.

For example, how to properly use auth.py and then do an option_chain.py.

How does one correctly login? How do I get the information that I need to type in for some of these parameters? option_id, etc? Some basics on this would be greatly appreciated and I'm sure helpful to others who like me, aren't as educated in this as some.

Many thanks!

dreamalligator commented 5 years ago

@AmeliorateOr, if you can get python3, pip3, and pipenv installed, you can simply do pipenv install fast-arrow, then check out @westonplatter's examples.

after that it is up to you! if you want to try interactive "homework"-like scripts, try Jupyter Notebooks maybe, or if youre trying to write an application with routing and such, maybe try Flask.

also, Weston! I just swapped from robin_stocks to this in my for-fun-and-probably-not-profit flask application after I noticed your repo in the category list. nice job! works great.

AmeliorateOr commented 5 years ago

@nebulousdog Thanks for getting back so quickly. I too was using robin_stocks, but after discovering this gem, I want to give this worthy try.

I have python3, pip3 already, but has never used pipenv. Is pipenv required to run this?

I was simply trying to copy/paste some of the example scripts and get them to run, no luck as I hit errors that I'm not skilled enough to know how to fix.

AmeliorateOr commented 5 years ago

Let me be more specific to save some time, I'm trying to simply authenticate and pull options data. I get stopped out hard at the authenticate step with the following error.

File "fast_arrow_auth.py", line 11, in username = config['account']['username'] File "/usr/lib/python3.6/configparser.py", line 959, in getitem raise KeyError(key) KeyError: 'account'

dreamalligator commented 5 years ago

pipenv isnt necessary, but it makes life easier. instead of separately handling pip, virtualenv, requirements.txt, setup.py, (etc) you just have your Pipfile, and it keeps a Pipfile.lock like how Yarn keeps a package-lock file. All that said though, it is definitely not needed. There's a Pipefile and Pipfile.lock in this repo, so even if it isnt in the readme, it means the developer is using it. if you installed your dependencies with pipenv install --dev, you'd get better dependency versions. Also, it depends if youre intending to make a library, or an application, but since youre in the learning phase, it really doesnt matter.

if you want to copy-paste pieces, youre probably going to learn faster by using Jupyter notebooks. Give it a try, https://jupyter.org/try.

Per your output, it looks like you dont have a config file set up. Test using with this example. You'll need to create a config file set up like so.

westonplatter commented 5 years ago

@nebulousdog thanks for chiming in the question. Great answers and context.

@AmeliorateOr try @nebulousdog's suggestion of creating a config.debug.ini file in the fast_arrow directory and add your username and password. config.debug.ini is explicitly gitignored to protect you from accidentally committing those secrets in code.

AmeliorateOr commented 5 years ago

@nebulousdog and @westonplatter Thanks for giving me some tips to get this thing going. Okay so I've got pip3, python3, and pipenv up and a properly placed config.debug.ini file in the fast_arrow directory.

I'm still not quite there, but much closer, but I'll close this now and post again if I have any further issues. Thanks again.