bitvavo / python-bitvavo-api

Python wrapper for the Bitvavo API
https://pypi.org/project/python-bitvavo-api/
ISC License
38 stars 25 forks source link

Fix documentation #23

Open ju5t opened 3 years ago

ju5t commented 3 years ago

The Python documentation is incorrect. It says:

from python_bitvavo_api.bitvavo import Bitvavo

bitvavo = Bitvavo('<APIKEY>', '<APISECRET>')
response = bitvavo.trades('BTC-EUR', {})
for item in response:
  print(item)

But Bitvavo expects a dictionary, not two separate parameters. Fixing the documentation is probably the easiest, although to be fair, the dictionary should go. It's much cleaner to use arguments.

In some cases kwargs are a good fit too, but arguments > kwargs > dictionaries.

NostraDavid commented 2 years ago

This has already been fixed :)