Skip to main content

Python ok.ru API wrapper

Project description

https://img.shields.io/badge/license-BSD-blue.svg https://img.shields.io/pypi/v/aiookru.svg https://img.shields.io/pypi/pyversions/aiookru.svg https://readthedocs.org/projects/aiookru/badge/?version=latest https://travis-ci.org/KonstantinTogoi/aiookru.svg

aiookru

aiookru is a python ok.ru API wrapper. The main features are:

Usage

To use ok.ru API you need a registered app and ok.ru account. For more details, see aiookru Documentation.

Client application

Use ClientSession when REST API is needed in:

  • client component of the client-server application

  • standalone mobile/desktop application

i.e. when you embed your app’s info (application key) in publicly available code.

from aiookru import ClientSession, API

session = ClientSession(app_id, app_key, access_token, session_secret_key)
api = API(session)

events = await api.events.get()
friends = await api.friends.get()

Pass session_secret_key and access_token that were received after authorization. For more details, see authorization instruction.

Server application

Use ServerSession when REST API is needed in:

  • server component of the client-server application

  • requests from your servers

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 app_secret_key and access_token that was received after authorization. For more details, see authorization instruction.

Installation

pip install aiookru

or

python setup.py install

Supported Python Versions

Python 3.5, 3.6, 3.7 and 3.8 are supported.

Test

Run all tests.

python setup.py test

Run tests with PyTest.

python -m pytest [-k TEST_NAME]

License

aiookru is released under the BSD 2-Clause License.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

aiookru-0.1.1.tar.gz (8.8 kB view details)

Uploaded Source

Built Distribution

aiookru-0.1.1-py3-none-any.whl (9.5 kB view details)

Uploaded Python 3

File details

Details for the file aiookru-0.1.1.tar.gz.

File metadata

  • Download URL: aiookru-0.1.1.tar.gz
  • Upload date:
  • Size: 8.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.15.0 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.1.3 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.5.6

File hashes

Hashes for aiookru-0.1.1.tar.gz
Algorithm Hash digest
SHA256 86b4b356d36f7def83f30b26ca9f78991d3f43af368126e20e2c88ffadc85345
MD5 890313f6603ef4fdba94b08def1347e5
BLAKE2b-256 dd553061453fab1d2576999d6653104f5972208a9891a95eb23abb245d4fa448

See more details on using hashes here.

File details

Details for the file aiookru-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: aiookru-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 9.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.15.0 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.1.3 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.5.6

File hashes

Hashes for aiookru-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 f12ef15c46ba40ccb76bc23d8840a5863c139a300df3ca11752d40e2a4d35a66
MD5 58fcb449b44d737af502502f22d7d5fc
BLAKE2b-256 020265fc15d101ce76f94de6a6d00e48f96cc8abaf607a43309847ba107c5e20

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page