Описание примеров, keyboard в docs (#155)

* README.MD for examples
* tests

Author: Igor

docs/index.rst

@@ -31,6 +31,7 @@ vk_api – Python модуль для написания скриптов для
    requests_pool
    tools
    upload
+   keyboard
    exceptions
    jconfig
 

examples/README.md

@@ -0,0 +1,17 @@
+Примеры использования библиотеки vk_api
+======
+'python@vk.com' замените на ваш логин, а 'mypassword' на пароль
+
+'bot_api_token' нужно заменить на токен группы
+* [Отправка запросов к API (VkApi)](./simple_example.py)
+* [Загрузка фото (VKUpload)](./upload_photo.py)
+* [Обработка двухфакторной аутентификации](./two_factor_auth.py)
+* [Обработка капчи](./captcha_handle.py)
+* [Работа с пользовательским Long Poll (VkLongpoll)](./longpoll.py)
+* [Работа с оберткой над execute (VkFunction)](./execute_functions.py)
+* [Получение альбомов музыки (VkAudio)](./get_album_audio.py)
+* [Получение аудиозаписей (VkAudio)](./get_all_audio.py)
+* [Составление клавиатуры для бота группы (VkKeyboard)](./keyboard.py)
+* [Получение большого кол-ва объектов (VkTools)](./get_full_wall.py)
+* [Работа с VkRequestsPool](./requests_pool.py)
+* [Работа с прокси и использование таймаутов](./proxies_timeout_retries.py)

examples/execute_functions.py

@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-""" Пример использования VkFunctions - обертки над методом execute
+""" Пример использования VkFunction - обертки над методом execute
 
     Описание VKScript (языка execute): https://vk.com/dev/execute
 """

examples/requests_pool.py

@@ -42,7 +42,7 @@ def main():
         """ Если запрос был завершен с ошибкой, то при обращении к результату
         будет выбрасываться исключение
         """
-        _ = request_with_error.result
+        request_with_error.result
     except vk_api.VkRequestsPoolException as e:
         print('Error:', e)
 

jconfig/base.py

@@ -9,10 +9,8 @@
 
 
 class BaseConfig(object):
-    r"""
-    Абстрактный базовый класс конфигурации
-
-    У наследуемых классов должен быть определен `__slots__`
+    r"""Абстрактный базовый класс конфигурации.
+        У наследуемых классов должен быть определен `__slots__`
 
     :param section: имя подкатегории в конфиге
     :param \**kwargs: будут переданы в :func:`load`

jconfig/jconfig.py

@@ -14,8 +14,7 @@
 
 
 class Config(BaseConfig):
-    """
-    Класс конфигурации в файле
+    """ Класс конфигурации в файле
 
     :param filename: имя файла
     """

jconfig/memory.py

@@ -1,18 +1,17 @@
 # -*- coding: utf-8 -*-
 """
-@author: python273
-@contact: https://vk.com/python273
-@license Apache License, Version 2.0, see LICENSE file
+:authors: python273
+:contact: https://vk.com/python273
+:license: Apache License, Version 2.0, see LICENSE file
 
-Copyright (C) 2018
+:copyright: (c) 2018 python273
 """
 
 from .base import BaseConfig
 
 
 class MemoryConfig(BaseConfig):
-    """
-    Класс конфигурации в памяти
+    """ Класс конфигурации в памяти
 
     :param settings: существующий dict с конфигом
     """

setup.py

@@ -3,11 +3,11 @@
 from setuptools import setup
 
 """
-@author: python273
-@contact: https://vk.com/python273
-@license Apache License, Version 2.0, see LICENSE file
+:authors: python273
+:contact: https://vk.com/python273
+:license: Apache License, Version 2.0, see LICENSE file
 
-Copyright (C) 2018
+:copyright: (c) 2018 python273
 """
 
 

tests/test_api.py

@@ -0,0 +1,13 @@
+import os
+
+import vk_api
+
+vk = vk_api.VkApi(login=os.environ['LOGIN'], password=os.environ['PASSWORD'])
+vk.auth(token_only=True)
+api = vk.get_api()
+
+
+def test_api():
+    user_info = api.users.get(user_ids=1)
+    assert isinstance(user_info, list)
+    assert user_info[0]['id'] == 1

tests/test_execute.py

@@ -0,0 +1,16 @@
+import os
+
+from vk_api import VkApi
+from vk_api.execute import VkFunction
+
+vk = VkApi(login=os.environ['LOGIN'], password=os.environ['PASSWORD'])
+vk.auth(token_only=True)
+
+
+def test_execute():
+    func_add = VkFunction('return %(x)s + %(y)s;', args=('x', 'y'))
+    func_get = VkFunction('return API.users.get(%(values)s)[0]["id"];',
+                          args=('values',))
+
+    assert func_add(vk, 2, 6) == 8
+    assert func_get(vk, {'user_ids': 'durov'}) == 1