Skip to main content

API Client for sailplay.ru

Project description

Python client for API sailplay.ru

Build Status Coverals https://pypip.in/d/sailplay/badge.png https://badge.fury.io/py/sailplay.png

Docs are available at https://sailplay.readthedocs.org/. Pull requests with documentation enhancements and/or fixes are awesome and most welcome.

Requirements

  • python >= 2.6

Installation

sailplay could be installed using pip:

pip install sailplay

Usage

Initialize API client

You should have pin, store_department_id and store_department_key from the service.

from sailplay import SailPlayClient

client = SailPlayClient(pin, store_department_id, store_department_key)

Additional params

client = SailPlayClient(
    pin, store_department_id, store_department_key,
    token="token-here", # Set token manually (default "")
    silence=True,       # Dont fail on API errors (default False)
    loglevel="debug",   # Set log level (default INFO)
)

Get API token

client.login()
print client.token

Working with api

Sailplay have nice and easy syntax. Just have a look:

# Get events list  http://sailplay.ru/api/v2/events/list/
client.api.events.list()

# Create a new user http://sailplay.ru/api/v2/users/add/?...
client.api.users.add(user_phone='...', first_name='...', last_name='...')

# Get info about user http://sailplay.ru/api/v2/users/info/?...
client.api.users.info(user_phone='...')

# Create purchase http://sailplay.ru/api/v2/purchases/new/?...
client.api.purchases.new(**params)

# You also could use getitem syntax for params
client.api.users['custom-vars'](**params)
# Same as
client.api['users']['custom-vars'](**params)

# And etc. I hope you make decision how the client works :)

For now client chooses API version automaticaly.

Context manager

You could redefine the client settings in context:

with client.ctx(silence=True):
    # Errors will not be raised here
    client.api.users.add(user_phone='...', first_name='...', last_name='...')

Raw api request

You could make raw request to sailplay API:

client.request(method='GET', url='/users/info', data={...})

Have a nice codding!

Bug tracker

If you have any suggestions, bug reports or annoyances please report them to the issue tracker at https://github.com/klen/sailplay/issues

Contributing

Development of starter happens at github: https://github.com/klen/sailplay

Contributors

  • klen (Kirill Klenov)

License

Licensed under a BSD 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

sailplay-0.2.0.tar.gz (5.5 kB view details)

Uploaded Source

Built Distribution

sailplay-0.2.0-py2.py3-none-any.whl (6.4 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file sailplay-0.2.0.tar.gz.

File metadata

  • Download URL: sailplay-0.2.0.tar.gz
  • Upload date:
  • Size: 5.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for sailplay-0.2.0.tar.gz
Algorithm Hash digest
SHA256 b62627d55b305e95e893b522a601c71f19ecc7992ffaa451a004bef860fbace2
MD5 f1d08704668aaf0fea5fcaf3e393004d
BLAKE2b-256 cb607534e9f626c2aad2979833de3655be9c078d425dd191e477be131bc80c95

See more details on using hashes here.

File details

Details for the file sailplay-0.2.0-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for sailplay-0.2.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 bd50842530f1476c63dd69d1882eb9ce416c60ae67a4bc6f78ce183066aeaf92
MD5 cd099a02fb5f2a3835e4f1f7ca05411a
BLAKE2b-256 a8502764f66c1f935f511d57e28d5a5fc705ebc3520cfc84e42375c15752f0ce

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