Welcome to Kuna API wrapper’s documentation!¶

Contents:

Kuna exchange API wrapper¶

https://travis-ci.org/DmytroLitvinov/kuna.svg?branch=master

kuna is a Python package providing access to the Kuna exchange server API. Original documentation of Kuna exchange API here: https://docs.kuna.io/docs

Installation¶

Stable release¶

To install Kuna API wrapper, run this command in your terminal:

$ pip install kuna

This is the preferred method to install Kuna API wrapper, as it will always install the most recent stable release.

If you don’t have pip installed, this Python installation guide can guide you through the process.

From sources¶

The sources for Kuna API wrapper can be downloaded from the Github repo.

You can either clone the public repository:

$ git clone git://github.com/DmytroLitvinov/kuna

Or download the tarball:

$ curl  -OL https://github.com/DmytroLitvinov/kuna/tarball/master

Once you have a copy of the source, you can install it with:

$ python setup.py install

Usage¶

To use Kuna API wrapper in a project:

import kuna

graph_kuna = kuna.KunaAPI()

# If you need User methods, provide public_key and private_key
graph_kuna = kuna.KunaAPI(public_key='your_public_key', private_key='your_private_key')

Contributing¶

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

You can contribute in many ways:

Types of Contributions¶

Report Bugs¶

Report bugs at https://github.com/DmytroLitvinov/kuna/issues.

If you are reporting a bug, please include:

Your operating system name and version.
Any details about your local setup that might be helpful in troubleshooting.
Detailed steps to reproduce the bug.

Fix Bugs¶

Look through the GitHub issues for bugs. Anything tagged with “bug” and “help wanted” is open to whoever wants to implement it.

Implement Features¶

Look through the GitHub issues for features. Anything tagged with “enhancement” and “help wanted” is open to whoever wants to implement it.

Write Documentation¶

Kuna API wrapper could always use more documentation, whether as part of the official Kuna API wrapper docs, in docstrings, or even on the web in blog posts, articles, and such.

Submit Feedback¶

The best way to send feedback is to file an issue at https://github.com/DmytroLitvinov/kuna/issues.

If you are proposing a feature:

Explain in detail how it would work.
Keep the scope as narrow as possible, to make it easier to implement.
Remember that this is a volunteer-driven project, and that contributions are welcome :)

Get Started!¶

Ready to contribute? Here’s how to set up kuna for local development.

Fork the kuna repo on GitHub.

Clone your fork locally:

$ git clone git@github.com:your_name_here/kuna.git

Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:
```
$ mkvirtualenv kuna
$ cd kuna/
$ python setup.py develop
```
Create a branch for local development:
```
$ git checkout -b name-of-your-bugfix-or-feature
```
Now you can make your changes locally.
When you’re done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox:
```
$ flake8 kuna tests
$ python setup.py test or py.test
$ tox
```
To get flake8 and tox, just pip install them into your virtualenv.

Commit your changes and push your branch to GitHub:

$ git add .
$ git commit -m "Your detailed description of your changes."
$ git push origin name-of-your-bugfix-or-feature

Submit a pull request through the GitHub website.

Pull Request Guidelines¶

Before you submit a pull request, check that it meets these guidelines:

The pull request should include tests.
If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.rst.
The pull request should work for Python 3.6, 3.7, 3.8 and 3.9, and for PyPy. Check https://travis-ci.org/DmytroLitvinov/kuna/pull_requests and make sure that the tests pass for all supported Python versions.

Tips¶

To run a subset of tests:

$ python -m unittest tests.test_kuna

Credits¶

Development Lead¶

Dmytro Litvinov <me@dmytrolitvinov.com> @DmytroLitvinov

Contributors¶

Vsevolod Lobko @sevikkk
Dmytro Kazanzhy @kazanzhy

History¶

0.4.2 (2021-12-28)¶

Fix import [#100](https://github.com/DmytroLitvinov/kuna/issues/100)
Requires Python>=3.6

0.4.1 (2021-10-14)¶

Fix import [#80](https://github.com/DmytroLitvinov/kuna/issues/80)

0.4.0 (2021-04-28)¶

Add support for API v3
Drop support for Python < 3.6
Add deprecation warning for API v2

0.3.3 (2018-11-08)¶

Upgrade packages, update README.rst

0.3.2 (2018-05-11)¶

Fix .rst files for PyPi description

0.3.1 (2018-05-11)¶

Make ‘tonce’ more granular

0.3.0 (2018-04-29)¶

Remove a strict binding to market pairs

0.2.12 (2018-04-06)¶

Remove OTX/BTC

0.2.11 (2018-03-20)¶

Change on EOS pair; small refactor

0.2.10 (2018-03-17)¶

Add new pairs XLM/UAH, TUSD/UAH

0.2.9 (2018-03-11)¶

Add new pair HKN/BTC ‘hknbtc

0.2.8 (2018-02-13)¶

Add new pairs EOS/BTC ‘eosbtc’, FOOD/BTC ‘foodbtc’, OTX/BTC ‘otxbtc’

0.2.7 (2018-02-09)¶

Add new pair XRP/UAH ‘xrpuah’

0.2.6 (2018-01-06)¶

Add new pair BCH/UAH ‘bchuah’

0.2.5 (2017-12-31)¶

Fix market pair ‘golosgbg’ to ‘golgbg’ and also add new pairs ‘rbtc’, ‘arnbtc’, ‘evrbtc’, ‘b2bbtc’

0.2.4 (2017-11-07)¶

Fix bug for User method: for correct generate signature it needs to pass assorted params.

0.2.3 (2017-10-31)¶

Add new pair

0.2.2 (2017-10-31)¶

Speed up code by change string concatenation
Improve docs structure
Minor change at code logic for getting signature

0.2.1 (2017-10-29)¶

Add User methods

0.2.0 (2017-10-29)¶

Add public methods without unittests.

0.1.0 (2017-10-28)¶

First release on PyPI.