Metadata-Version: 2.1
Name: aiovkcom
Version: 0.0.2
Summary: vk.com Python REST API wrapper
Home-page: https://github.com/KonstantinTogoi/aiovkcom
Author: Konstantin Togoi
Author-email: konstantin.togoi@protonmail.com
License: BSD
Description: # vk.com Python REST API wrapper
        
        - [About](#about)
        - [Getting Started](#getting-started)
        
        
        ## About
        
        This is a [vk.com](https://vk.com) (Russian social network) python API wrapper.
        The goal is to support all API methods: https://vk.com/dev/methods.
        
        
        ## Getting Started
        
        Install package using pip
        
        ```bash
        pip install aiovkcom
        ```
        
        To use VK API you need a registered app and login account in the social network.
        
        1. Sign up in [vk.com](https://vk.com)
        2. Create **standalone** application.
        3. Save **App ID**.
        4. Use App ID, list of required permissions and user credentials to get **access token**.
        5. Use the access token to make method requests.
        
        After signing up go to https://vk.com/dev/standalone and create application.
        
        ```python
        app_id = 'your App ID'
        ```
        
        ### ImplicitSession
        
        You can authenticate with [VK API OAuth2](https://vk.com/dev/implicit_flow_user) by passing user credentials and permissions to `ImplicitSession`.
        
        ```python
        from aiovkcom import ImplicitSession
        from aiovkcom.permissions import bit_scope, PERMISSIONS
        
        phone = '+1999123456'
        password = 'user password'
        
        session = await ImplicitSession(
            app_id=app_id,
            login=phone,  # set phone number or e-mail as login
            passwd=password,
            scope=bit_scope(PERMISSIONS),  # get all possible permissions
            v='5.101',  # set version for all requests
        )
        ```
        
        List of all permissions is available here: https://vk.com/dev/permissions.
        
        Now you can execute API requests (see [Executing API requests](#executing-api-requests)). After authentication you will get access token **session.access_token**. Save it to make requests later:
        
        ```python
        access_token = session.access_token
        ```
        
        ### TokenSession
        
        If you already have an access token you can instantiate `TokenSession`
        
        ```python
        from aiovkcom import TokenSession
        
        session = TokenSession(access_token, v='5.101')
        ```
        
        and execute requests.
        
        ### Executing API requests
        
        List of all methods is available here: https://vk.com/dev/methods.
        
        ```python
        from aiovkcom import API
        
        api = API(session)
        
        # current user's friends
        friends = await api.friends.get()
        
        # current user's groups
        groups = await api.groups.get()
        ```
        
        List of objects is available here: https://vk.com/dev/objects
        
        ## License
        
        **aiovkcom** is released under the BSD 2-Clause License.
        
Keywords: vk.com api asyncio
Platform: UNKNOWN
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Description-Content-Type: text/markdown
