Metadata-Version: 1.1
Name: clikraken
Version: 0.0.1.dev19
Summary: Command-line client for the Kraken exchange
Home-page: https://github.com/zertrin/clikraken
Author: Marc Gallet
Author-email: zertrin@gmail.com
License: Apache 2.0
Description: clikraken
        =========
        
        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 <https://www.apache.org/licenses/LICENSE-2.0>`__.
        
        Dependencies
        ~~~~~~~~~~~~
        
        -  `python3-krakenex <https://github.com/veox/python3-krakenex>`__ code
           is licensed under the LGPLv3 license.
        -  `Arrow <https://github.com/crsmithdev/arrow/blob/master/LICENSE>`__
           code is licensed under is licensed under the Apache License, Version
           2.0.
        
        
Platform: UNKNOWN
Classifier: Programming Language :: Python
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Topic :: Office/Business :: Financial
Classifier: Topic :: Office/Business :: Financial :: Investment
