Metadata-Version: 1.2
Name: aiookru
Version: 0.1.0
Summary: ok.ru Python REST API wrapper
Home-page: https://github.com/KonstantinTogoi/aiookru
Author: Konstantin Togoi
Author-email: konstantin.togoi@protonmail.com
License: BSD
Description: .. image:: https://img.shields.io/badge/license-BSD-blue.svg
            :target: https://github.com/KonstantinTogoi/aiookru/blob/master/LICENSE
        
        .. image:: https://img.shields.io/pypi/v/aiookru.svg
            :target: https://pypi.python.org/pypi/aiookru
        
        .. image:: https://img.shields.io/pypi/pyversions/aiookru.svg
            :target: https://pypi.python.org/pypi/aiookru
        
        .. image:: https://img.shields.io/badge/docs-latest-brightgreen.svg
            :target: https://aiookru.readthedocs.io/en/latest/
        
        .. image:: https://travis-ci.org/KonstantinTogoi/aiookru.svg
            :target: https://travis-ci.org/KonstantinTogoi/aiookru
        
        .. index-start-marker1
        
        aiookru
        =======
        
        aiookru is a `ok.ru <https://ok.ru>`_ python API wrapper.
        The main features are:
        
        * authorization (`Authorization Code <https://oauth.net/2/grant-types/authorization-code/>`_, `Implicit Flow <https://oauth.net/2/grant-types/implicit/>`_, `Password Grant <https://oauth.net/2/grant-types/password/>`_, `Refresh Token <https://oauth.net/2/grant-types/refresh-token/>`_)
        * `REST API <https://apiok.ru/en/dev/methods/rest>`_ methods
        
        
        Usage
        -----
        
        To use ok.ru API you need a registered app and `OK.ru <https://ok.ru>`_ account.
        For more details, see
        `aiookru Documentation <https://aiookru.readthedocs.io/>`_.
        
        Client application
        ~~~~~~~~~~~~~~~~~~
        
        Use :code:`ClientSession` when REST API is needed in:
        
        - a client component of the client-server application
        - a standalone mobile/desktop application
        
        i.e. when you embed your app's info (application key) in publicly available code.
        
        .. code-block:: python
        
            from aiookru import ClientSession, API
        
            session = ClientSession(app_id, app_key, session_secret_key)
            api = API(session)
        
            events = await api.events.get()
            friends = await api.friends.get()
        
        Pass :code:`session_secret_key` that was received after authorization.
        For more details, see `aiookru Documentation <https://aiookru.readthedocs.io/>`_.
        
        Server application
        ~~~~~~~~~~~~~~~~~~
        
        Use :code:`ServerSession` when REST API is needed in:
        
        - a server component of the client-server application
        - requests from your servers
        
        .. code-block:: python
        
            from aiookru import ServerSession, API
        
            session = ServerSession(app_id, app_key, app_secret_key, access_token)
            api = API(session)
        
            events = await api.events.get()
            friends = await api.friends.get()
        
        Pass :code:`access_token` that was received after authorization.
        For more details, see
        `aiookru Documentation <https://aiookru.readthedocs.io/>`_.
        
        Installation
        ------------
        
        .. code-block:: shell
        
            pip install aiookru
        
        or
        
        .. code-block::
        
            python setup.py install
        
        Supported Python Versions
        -------------------------
        
        Python 3.5, 3.6, 3.7 and 3.8 are supported.
        
        .. index-end-marker1
        
        Test
        ----
        
        Run all tests.
        
        .. code-block:: shell
        
            python setup.py test
        
        Run tests with PyTest.
        
        .. code-block:: shell
        
            python -m pytest [-k TEST_NAME]
        
        License
        -------
        
        **aiookru** is released under the BSD 2-Clause License.
        
Keywords: ok.ru rest 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.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.5
