Cub Client for Python

Requirements

Python version 2.7, 3.5, 3.6, 3.7, 3.8, 3.9 or PyPy. For better security, we recommend to install Python Requests library, since it supports SSL certs verification. To install Requests, simply run:

$ pip install requests

or using easy_install:

$ easy_install requests

Requests library is optional. If it is not installed, Cub Client will use urllib2 instead. All features of Cub Client will remain fully functional, but it will not verify SSL certificate of Cub API.

Installation

Install using pip, recommended (why?):

$ pip install cub

or using easy_install:

$ easy_install cub

Usage

User Login

import cub

cub.config.api_key = '<your-secret-key>'

user = cub.User.login(
    username='<username>',
    password='<password>',
)

Get User by token

import cub

user = cub.User.get('<token>')

Report bugs

Report issues to the project's Issues Tracking on Github.

Development

Run tests with local python:

$ INTEGRATION_TESTS_SECRET_KEY={key} INTEGRATION_TESTS_USER_PASS={password} pytest -v --tb=short tests.py

Install tox:

$ pip install tox

Run tests with tox:

$ INTEGRATION_TESTS_SECRET_KEY={key} INTEGRATION_TESTS_USER_PASS={password} tox

To install additional pythons, you can use pyenv:

$ pyenv install 3.5.10
$ pyenv install 3.6.12
$ # in project dir run pyenv local
$ pyenv local system 3.5.10 3.6.12