Metadata-Version: 2.1
Name: vkcoin
Version: 1.1.0
Summary: Враппер для платёжного API VK Coin
Home-page: https://github.com/crinny/vkcoin
Author: crinny
Author-email: isfellop@gmail.com
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3.6
Description-Content-Type: text/markdown
Requires-Dist: requests

# vkcoin
Враппер для платёжного API VK Coin. https://vk.com/@hs-marchant-api
# Установка
На данный момент установка через репозиторий pip недоступна, используйте установку через git
* Скачайте и установите [Python](https://www.python.org/downloads/) версии 3.6 и выше
* Если вы используете Windows, установите [git](https://git-scm.com/download/win)
* Введите следующую команду в командную строку:
```bash
pip install git+git://github.com/crinny/vkcoin.git
```
* Вы прекрасны!
# Начало работы
Для начала разработки, необходимо создать в своей папке исполняемый файл с расширением **.py**, например **test.py**. Вы не можете назвать файл vkcoin.py, так как это приведёт к конфликту. Теперь файл нужно открыть и импортировать библиотеку:
```python
import vkcoin

merchant = vkcoin.Merchant()
```
|Параметр|Тип|Описание|
|-|-|-|
|user_id|Integer|ID аккаунта ВКонтакте|
|key|String|Ключ для взаимодействия с API|
# Методы
Необязательные параметры при вызове функций выделены _курсивом_.

[`get_payment_url`](https://vk.com/@hs-marchant-api?anchor=ssylka-na-oplatu) - получет ссылку на оплату VK Coin
```python
result = merchant.get_payment_url(amount=10, payload=78922, free_amount=False)
print(result)
```
|Параметр|Тип|Описание|
|-|-|-|
|amount|Integer|Количество VK Coin для перевода|
|_payload_|Integer|Число от -2ккк до 2ккк, вернется в списке транзаций|
|_free_amount_|Boolean|True, что бы позволить пользователю изменять сумму перевода|
#
[`get_transactions`](https://vk.com/@hs-marchant-api?anchor=poluchenie-spiska-tranzaktsy) - получает список ваших транзакций
```python
result = merchant.get_payment_url(tx=[1])
print(result)
```
|Параметр|Тип|Описание|
|-|-|-|
|tx|List|Массив ID переводов для получения или [1] - последние 1000 транзакций, [2] - 100|
|_last_tx_|Integer|Если указать номер последней транзакции то будут возвращены только транзакции после указанной|
#
[`send`](https://vk.com/@hs-marchant-api?anchor=perevod) - делает перевод другому пользователю
```python
result = merchant.send(amount=100, to_id=371576679)  # Если запустить этот код, вы переведёте мне 100 VK Coin :)
print(result)
```
|Параметр|Тип|Описание|
|-|-|-|
|amount|Integer|Сумма перевода|
|to_id|Integer|ID аккаунта, на который будет совершён перевод|

# Где меня можно найти
* [ВКонтакте](https://vk.com/crinny)
* [Telegram](https://t.me/truecrinny)
* [Чат ВКонтакте по VK Coin API (не мой)](https://vk.me/join/AJQ1d5eSUQ81wnwgfHSRktCi)

