.. image:: https://travis-ci.org/veox/python3-krakenex.svg?branch=master
:alt: Latest Travis continuous integration build
:target: https://travis-ci.org/veox/python3-krakenex
.. image:: https://readthedocs.org/projects/python3-krakenex/badge/
:alt: Read latest documentation
:target: https://python3-krakenex.readthedocs.io/
.. image:: https://badge.fury.io/py/krakenex.svg
:alt: Latest PyPI release
:target: https://badge.fury.io/py/krakenex
.. image:: https://badges.gitter.im/python3-krakenex/Lobby.svg
:alt: Development discussion at https://gitter.im/python3-krakenex/Lobby
:target: https://gitter.im/python3-krakenex/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge
`krakenex`
==========
Kraken.com exchange REST API, Python 3 package.
This package is intentionally as lean as possible, and only
provides a minimal interface to the `Kraken`_ cryptocurrency
exchange.
Intended for developers, not traders.
.. _Kraken: https://kraken.com/
Software that uses ``krakenex``
-------------------------------
Libraries
^^^^^^^^^
* pykrakenapi_ - nicely wraps API methods into regular Python methods, and JSON
responses into Pandas_ dataframes (available on PyPI!)
* CurrencyViewer_ - short python3 framework for data extraction, conversion, and
smooth development experience (available on PyPI!)
.. _pykrakenapi: https://github.com/dominiktraxl/pykrakenapi
.. _Pandas: http://pandas.pydata.org/
.. _CurrencyViewer: https://github.com/smechaab/CurrencyViewer
Clients
^^^^^^^
* clikraken_ - command-line client for the Kraken exchange (available on PyPI!)
* Telegram-Kraken-Bot_ - Telegram bot to trade on Kraken exchange
.. _clikraken: https://github.com/zertrin/clikraken
.. _Telegram-Kraken-Bot: https://github.com/Endogen/Telegram-Kraken-Bot
Documentation
-------------
View the latest_ or stable_ online 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 html`` in ``doc``.
This requires ``sphinx`` and its ``rtd`` theme.
For the most up-to-date list of public/private Kraken API methods, see
their `API documentation`_.
.. _latest: https://python3-krakenex.readthedocs.io/en/latest/
.. _stable: https://python3-krakenex.readthedocs.io/en/stable/
.. _API documentation: https://docs.kraken.com/rest/
Examples
--------
A few package use examples are available in the examples_ directory.
.. _examples: examples/
Installation
------------
This package requires Python 3.3 or later. The module will be called
``krakenex``.
A `PyPI package`_ is available.
For general use, there is only one direct dependency: `requests`_.
.. _PyPI package: https://pypi.python.org/pypi/krakenex
.. _requests: http://docs.python-requests.org/
Locally for a project, in a virtual environment (recommended)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
This requires ``python-virtualenv`` and ``python-pip``.
In a terminal:
.. code-block:: sh
# create directory for a project that'll be using krakenex
mkdir my-project
cd my-project
# bootstrap virtualenv
export VIRTUAL_ENV=.virtualenv/krakenex
mkdir -p $VIRTUAL_ENV
virtualenv $VIRTUAL_ENV
source $VIRTUAL_ENV/bin/activate
# install from PyPI
pip install krakenex
For more information on ``virtualenv``, see `its documentation`_.
.. _its documentation: https://virtualenv.pypa.io/en/stable/
For the user
^^^^^^^^^^^^
Using ``pip``:
.. code-block:: sh
# install from PyPI
pip install --user krakenex
# ... or from local git repo clone
cd CLONE-OF-GIT-REPO
pip install --user .
System-wide (not recommended)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
In general, use the distribution's package manager.
If it's unavailable, one can use ``pip``:
.. code-block:: sh
# install from PyPI
pip install krakenex
# ... or from local copy
pip install /path/to/clone/of/repo
Attribution
-----------
"Core" code is licensed under LGPLv3. See ``LICENSE.txt`` and
``LICENSE-GPLv3.txt``.
Examples are licensed under the Simplified BSD license. See
``examples/LICENSE.txt``.
`Payward's PHP API`_, Alan McIntyre's `BTC-e API`_,
and ScriptProdigy's `Cryptsy Python API`_ were used as
examples when writing the original python2-krakenex_ package.
It was then ported to Python 3.
.. _Payward's PHP API: https://github.com/payward/kraken-api-client
.. _BTC-e API: https://github.com/alanmcintyre/btce-api
.. _Cryptsy Python API: https://github.com/ScriptProdigy/CryptsyPythonAPI
.. _python2-krakenex: https://github.com/veox/python2-krakenex
Development notes
-----------------
Do not annoy the Kraken with tests
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Some tests may be making queries to the Kraken API server.
If you intend to do development on this package, and have tests enabled
on `Travis 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.)
.. _Travis CI: https://travis-ci.org
No Python 2
^^^^^^^^^^^
This package will never support Python 2. There will be no changes made
to enable compatibility with Python 2. Python 3.0 was `released 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, see python2-krakenex_. Be
warned, though, that it is unmaintained.
.. _released in 2008: https://en.wikipedia.org/wiki/History_of_Python#Version_3.0
Raw data
{
"_id": null,
"home_page": "https://github.com/veox/python3-krakenex",
"name": "krakenex",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.3",
"maintainer_email": null,
"keywords": null,
"author": "Noel Maersk",
"author_email": "veox+packages+spamremove@veox.pw",
"download_url": "https://files.pythonhosted.org/packages/9a/b3/3e5edae73c8438602be16c2faa1126d720136e83af9980a4e73e1f0b4480/krakenex-2.2.2.tar.gz",
"platform": null,
"description": ".. image:: https://travis-ci.org/veox/python3-krakenex.svg?branch=master\n :alt: Latest Travis continuous integration build\n :target: https://travis-ci.org/veox/python3-krakenex\n.. image:: https://readthedocs.org/projects/python3-krakenex/badge/\n :alt: Read latest documentation\n :target: https://python3-krakenex.readthedocs.io/\n.. image:: https://badge.fury.io/py/krakenex.svg\n :alt: Latest PyPI release\n :target: https://badge.fury.io/py/krakenex\n.. image:: https://badges.gitter.im/python3-krakenex/Lobby.svg\n :alt: Development discussion at https://gitter.im/python3-krakenex/Lobby\n :target: https://gitter.im/python3-krakenex/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge\n\n\n`krakenex`\n==========\n\nKraken.com exchange REST API, Python 3 package.\n\nThis package is intentionally as lean as possible, and only\nprovides a minimal interface to the `Kraken`_ cryptocurrency\nexchange.\n\nIntended for developers, not traders.\n\n.. _Kraken: https://kraken.com/\n\n\nSoftware that uses ``krakenex``\n-------------------------------\n\nLibraries\n^^^^^^^^^\n\n* pykrakenapi_ - nicely wraps API methods into regular Python methods, and JSON\n responses into Pandas_ dataframes (available on PyPI!)\n* CurrencyViewer_ - short python3 framework for data extraction, conversion, and\n smooth development experience (available on PyPI!)\n\n.. _pykrakenapi: https://github.com/dominiktraxl/pykrakenapi\n.. _Pandas: http://pandas.pydata.org/\n.. _CurrencyViewer: https://github.com/smechaab/CurrencyViewer\n\nClients\n^^^^^^^\n\n* clikraken_ - command-line client for the Kraken exchange (available on PyPI!)\n* Telegram-Kraken-Bot_ - Telegram bot to trade on Kraken exchange\n\n.. _clikraken: https://github.com/zertrin/clikraken\n.. _Telegram-Kraken-Bot: https://github.com/Endogen/Telegram-Kraken-Bot\n\n\nDocumentation\n-------------\n\nView the latest_ or stable_ online at ReadTheDocs.\n\nThe code is documented in docstrings, and can be viewed with a text editor.\n\nYou can also generate your own with, e.g., ``make html`` in ``doc``.\nThis requires ``sphinx`` and its ``rtd`` theme.\n\nFor the most up-to-date list of public/private Kraken API methods, see\ntheir `API documentation`_.\n\n.. _latest: https://python3-krakenex.readthedocs.io/en/latest/\n.. _stable: https://python3-krakenex.readthedocs.io/en/stable/\n.. _API documentation: https://docs.kraken.com/rest/\n\n\nExamples\n--------\n\nA few package use examples are available in the examples_ directory.\n\n.. _examples: examples/\n\n\nInstallation\n------------\n\nThis package requires Python 3.3 or later. The module will be called\n``krakenex``.\n\nA `PyPI package`_ is available.\n\nFor general use, there is only one direct dependency: `requests`_.\n\n.. _PyPI package: https://pypi.python.org/pypi/krakenex\n.. _requests: http://docs.python-requests.org/\n\n\nLocally for a project, in a virtual environment (recommended)\n^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n\nThis requires ``python-virtualenv`` and ``python-pip``.\n\nIn a terminal:\n\n.. code-block:: sh\n\n # create directory for a project that'll be using krakenex\n mkdir my-project\n cd my-project\n # bootstrap virtualenv\n export VIRTUAL_ENV=.virtualenv/krakenex\n mkdir -p $VIRTUAL_ENV\n virtualenv $VIRTUAL_ENV\n source $VIRTUAL_ENV/bin/activate\n # install from PyPI\n pip install krakenex\n\nFor more information on ``virtualenv``, see `its documentation`_.\n\n.. _its documentation: https://virtualenv.pypa.io/en/stable/\n\nFor the user\n^^^^^^^^^^^^\n\nUsing ``pip``:\n\n.. code-block:: sh\n\n # install from PyPI\n pip install --user krakenex\n # ... or from local git repo clone\n cd CLONE-OF-GIT-REPO\n pip install --user .\n\nSystem-wide (not recommended)\n^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n\nIn general, use the distribution's package manager.\n\nIf it's unavailable, one can use ``pip``:\n\n.. code-block:: sh\n\n # install from PyPI\n pip install krakenex\n # ... or from local copy\n pip install /path/to/clone/of/repo\n\n \nAttribution\n-----------\n\n\"Core\" code is licensed under LGPLv3. See ``LICENSE.txt`` and\n``LICENSE-GPLv3.txt``.\n\nExamples are licensed under the Simplified BSD license. See\n``examples/LICENSE.txt``.\n\n`Payward's PHP API`_, Alan McIntyre's `BTC-e API`_,\nand ScriptProdigy's `Cryptsy Python API`_ were used as\nexamples when writing the original python2-krakenex_ package.\nIt was then ported to Python 3.\n\n.. _Payward's PHP API: https://github.com/payward/kraken-api-client\n.. _BTC-e API: https://github.com/alanmcintyre/btce-api\n.. _Cryptsy Python API: https://github.com/ScriptProdigy/CryptsyPythonAPI\n.. _python2-krakenex: https://github.com/veox/python2-krakenex\n\n\nDevelopment notes\n-----------------\n\nDo not annoy the Kraken with tests\n^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n\nSome tests may be making queries to the Kraken API server.\n\nIf you intend to do development on this package, and have tests enabled\non `Travis CI`_, be sure to limit concurrent jobs to 1, and enable all\npossible auto-cancellations.\n\n(Better yet, don't rely on public infrastructure, but run the tests\nlocally first.)\n\n.. _Travis CI: https://travis-ci.org\n\nNo Python 2\n^^^^^^^^^^^\n\nThis package will never support Python 2. There will be no changes made\nto enable compatibility with Python 2. Python 3.0 was `released in\n2008`_, before Bitcoin was.\n\nThere is no reason to support Python 2 except for compatibility with\nsystems from the pre-blockchain era.\n\nThe fact that some GNU/Linux distributions still ship with Python 2 as\nthe default seems unfortunate to me. However, I will not support this\nmadness with my precious time.\n\nIf you have a valid reason to use Python 2, see python2-krakenex_. Be\nwarned, though, that it is unmaintained.\n\n.. _released in 2008: https://en.wikipedia.org/wiki/History_of_Python#Version_3.0\n",
"bugtrack_url": null,
"license": null,
"summary": "kraken.com cryptocurrency exchange API",
"version": "2.2.2",
"project_urls": {
"Homepage": "https://github.com/veox/python3-krakenex"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9ab33e5edae73c8438602be16c2faa1126d720136e83af9980a4e73e1f0b4480",
"md5": "cc7f1c8d395fb707077b16d13962a62d",
"sha256": "3f7553c3295ce03c79a47701f3949066a64ab5d8656f9e97d13cf6bf22eacf7a"
},
"downloads": -1,
"filename": "krakenex-2.2.2.tar.gz",
"has_sig": false,
"md5_digest": "cc7f1c8d395fb707077b16d13962a62d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.3",
"size": 39463,
"upload_time": "2024-07-01T18:50:40",
"upload_time_iso_8601": "2024-07-01T18:50:40.764549Z",
"url": "https://files.pythonhosted.org/packages/9a/b3/3e5edae73c8438602be16c2faa1126d720136e83af9980a4e73e1f0b4480/krakenex-2.2.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-01 18:50:40",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "veox",
"github_project": "python3-krakenex",
"travis_ci": true,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "krakenex"
}
JSON
