Skip to main content

Command-line client for the Kraken exchange

Project description

Command-line client for the Kraken exchange

Installation

WARNING: This software is currently in development.

DO NOT USE for production!

You should install it in a virtualenv.

Step 1: Create a virtualenv

pyvenv ~/.venv/clikraken

And activate it:

source ~/.venv/clikraken/bin/activate

Step 2: Install dependencies

clikraken depends on two external modules:

  • arrow, for better handling of date and time

  • python3-krakenex, for the low-level interface with the Kraken API

Somehow you need to install the two dependencies manually before installing clikraken. I haven’t been successfull in making the dependency system of pip work consistently yet with python3-krakenex being only available as a Git repository.

Install arrow in the activated virtualenv:

pip install arrow

Install python3-krakenex in the activated virtualenv:

pip install -e "git+https://github.com/veox/python3-krakenex.git@33b758f1f56257a35da85b0b14eb9cb1afb7b045#egg=krakenex-0.0.6"

Step 3: Install clikraken

# make sure you have installed arrow and krakenex before!
pip install --pre clikraken

Step 4: Add your API key in the $HOME/.config/kraken.key file

You will need it to perform private queries to the Kraken API.

keykeykeykeykeykeykeykeykeykeykeykeykeykeykeykeykeykeykey
secretsecretsecretsecretsecretsecretsecretsecretsecretsecretsecretsecretsecretsecretsecret

Usage

First activate the virtualenv:

source ~/.venv/clikraken/bin/activate

Get help:

clikraken --help

Upgrade

In the activated virtualenv:

pip install -U --no-deps --pre clikraken

--no-deps is currently needed because trying to upgrade the dependency krakenex fails, because it is not available on PyPi, only as a Git repository.

Attribution

clikraken code is licensed under the Apache license, Version 2.0. See the LICENSE file. For the full text, see here.

Dependencies

  • python3-krakenex code is licensed under the LGPLv3 license.

  • Arrow code is licensed under is licensed under the Apache License, Version 2.0.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

clikraken-0.0.1.dev19.tar.gz (4.4 kB view hashes)

Uploaded Source

Built Distribution

clikraken-0.0.1.dev19-py3-none-any.whl (6.5 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page