Package: krakenex
krakenexKraken.com exchange REST API, Python 3 package.This package is intentionally as lean as possible, and only
provides a minimal interface to theKrakencryptocurrency
exchange.Intended for developers, not traders.Software that useskrakenexLibrariespykrakenapi- nicely wraps API methods into regular Python methods, and JSON
responses intoPandasdataframes (available on PyPI!)CurrencyViewer- short python3 framework for data extraction, conversion, and
smooth development experience (available on PyPI!)Clientsclikraken- command-line client for the Kraken exchange (available on PyPI!)Telegram-Kraken-Bot- Telegram bot to trade on Kraken exchangeDocumentationView thelatestorstableonline at ReadTheDocs.The code is documented in docstrings, and can be viewed with a text editor.You can also generate your own with, e.g.,make htmlindoc.
This requiressphinxand itsrtdtheme.For the most up-to-date list of public/private Kraken API methods, see
theirAPI documentation.ExamplesA few package use examples are available in theexamplesdirectory.InstallationThis package requires Python 3.3 or later. The module will be calledkrakenex.APyPI packageis available.For general use, there is only one direct dependency:requests.Locally for a project, in a virtual environment (recommended)This requirespython-virtualenvandpython-pip.In a terminal:# create directory for a project that'll be using krakenexmkdirmy-projectcdmy-project# bootstrap virtualenvexportVIRTUAL_ENV=.virtualenv/krakenexmkdir-p$VIRTUAL_ENVvirtualenv$VIRTUAL_ENVsource$VIRTUAL_ENV/bin/activate# install from PyPIpipinstallkrakenexFor more information onvirtualenv, seeits documentation.For the userUsingpip:# install from PyPIpipinstall--userkrakenex# ... or from local git repo clonecdCLONE-OF-GIT-REPOpipinstall--user.System-wide (not recommended)In general, use the distribution’s package manager.If it’s unavailable, one can usepip:# install from PyPIpipinstallkrakenex# ... or from local copypipinstall/path/to/clone/of/repoAttribution“Core” code is licensed under LGPLv3. SeeLICENSE.txtandLICENSE-GPLv3.txt.Examples are licensed under the Simplified BSD license. Seeexamples/LICENSE.txt.Payward’s PHP API, Alan McIntyre’sBTC-e API,
and ScriptProdigy’sCryptsy Python APIwere used as
examples when writing the originalpython2-krakenexpackage.
It was then ported to Python 3.Development notesDo not annoy the Kraken with testsSome tests may be making queries to the Kraken API server.If you intend to do development on this package, and have tests enabled
onTravis CI, be sure to limit concurrent jobs to 1, and enable all
possible auto-cancellations.(Better yet, don’t rely on public infrastructure, but run the tests
locally first.)No Python 2This package will never support Python 2. There will be no changes made
to enable compatibility with Python 2. Python 3.0 wasreleased in
2008, before Bitcoin was.There is no reason to support Python 2 except for compatibility with
systems from the pre-blockchain era.The fact that some GNU/Linux distributions still ship with Python 2 as
the default seems unfortunate to me. However, I will not support this
madness with my precious time.If you have a valid reason to use Python 2, seepython2-krakenex. Be
warned, though, that it is unmaintained.