Metadata-Version: 1.1
Name: python-vkontakte
Version: 1.0
Summary: Python library to access vkontakte social network api.
Home-page: https://github.com/sashgorokhov/python-vkontakte
Author: sashgorokhov
Author-email: sashgorokhov@gmail.com
License: MIT License
Download-URL: https://github.com/sashgorokhov/python-vkontakte/archive/master.zip
Description: python-vkontakte
        ****************
        
        .. image:: https://badge.fury.io/py/python-vkontakte.svg
            :target: https://badge.fury.io/py/python-vkontakte
        
        Python library to access vkontakte social network api.
        
        Installation
        ============
        
        Via pip:
        
        .. code-block:: shell
        
            pip install python-vkontakte
        
        Api
        ===
        
        .. code-block:: python
        
            import pyvkontakte
            api = pyvkontakte.VkontakteApi()
            api.call('users.get', user_ids=1) # [{'last_name': 'Р”СѓСЂРѕРІ', 'id': 1, 'first_name': 'РџР°РІРµР»'}]
        
        or calling method via class attribute:
        
        .. code-block:: python
        
            api.users_get(user_ids=1) # [{'last_name': 'Р”СѓСЂРѕРІ', 'id': 1, 'first_name': 'РџР°РІРµР»'}]
        
        Are both the same. In a second form, it is a method name where dots replaced with underscores - ``wall.getById`` will be ``wall_getById`` and so on.
        
        If you want to call some private api, which require access token, just create a api class with it:
        
        .. code-block:: python
        
            pyvkontakte.VkontakteApi('access token')
        
        Using different api version:
        
        .. code-block:: python
        
            pyvkontakte.VkontakteApi(v='5.50')
        
        If some error occures after api request (response json contains ``error`` insead of ``response`` key), ``pyvkontakte.VkontakteApiError`` will be raised.
        Special attribute ``json`` will be avaible on exception object, additionally exception str representation will contain error description and error code.
        
        Authorization
        =============
        
        For obtaining access token, you can use ``pyvkontakte.auth`` method.
        
        .. code-block:: python
        
            pyvkontakte.auth(login, password, client_id, scope)
        
        which will return dict with keys access_token, expires_in, user_id. If login or password is invalid, ``pyvkontakte.InvalidCredentials`` will be raised.
        If some parsing error occurs, ``pyvkontakte.ParsingError`` will be raised.
        Both ``pyvkontakte.InvalidCredentials`` and ``pyvkontakte.ParsingError`` are subclasses of ``pyvkontakte.VkontakteAuthError``.
        
        There is also a logger ``pyvkontakte`` (``pyvkontakte.auth`` and ``pyvkontakte.api``) enabled.
        ``pyvkontakte.api`` logs an INFO every request made with request params, and DEBUG with json of response
        
        
        .. :changelog:
        
        History
        -------
        
        1.0.0 (2016-04-16)
        ++++++++++++++++++
        
        * First PyPi release
        
        0.1.0 (2016-04-16)
        ++++++++++++++++++
        
        * Initial release
Keywords: vkontakte,api,vkontakte api
Platform: UNKNOWN
Requires: requests
Requires: beautifulsoup4
