Metadata-Version: 1.2
Name: cub
Version: 0.27.0
Summary: Cub Client for Python
Home-page: https://github.com/praetoriandigital/cub-python
Author: Denis Stebunov
Author-email: support@praetoriandigital.com
License: The MIT License (MIT)
Description: Cub Client for Python
        =====================
        
        .. image:: https://travis-ci.org/praetoriandigital/cub-python.svg?branch=master
                :target: https://travis-ci.org/praetoriandigital/cub-python
        
        Requirements
        ------------
        
        Python version 2.7, 3.4, 3.5, 3.6, 3.7, 3.8 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.
        
        .. _`Python Requests`: http://docs.python-requests.org/
        
        Installation
        ------------
        
        Install using pip, recommended (`why?`_)::
        
            $ pip install cub
        
        or using easy_install::
        
            $ easy_install cub
        
        .. _`why?`: http://www.pip-installer.org/en/latest/other-tools.html#pip-compared-to-easy-install
        
        Usage
        -----
        
        User Login
        ~~~~~~~~~~
        
        .. code:: python
        
            import cub
            import cub.config
        
            cub.config.api_key = '<your-secret-key>'
        
            user = cub.User.login(
                username='<username>',
                password='<password>',
            )
        
        
        Get User by token
        ~~~~~~~~~~~~~~~~~
        
        .. code:: python
        
            import cub
        
            user = cub.User.get('<token>')
        
        
        Report bugs
        -----------
        
        Report issues to the project's `Issues Tracking`_ on Github.
        
        .. _`Issues Tracking`: https://github.com/praetoriandigital/cub-python/issues
        
        
        Development
        -----------
        Add new encrypted travis env var::
        
            $ travis encrypt --repo=praetoriandigital/cub-python --add env.global MY_SECRET_ENV=super_secret
        
        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.4.9
            $ pyenv install 3.5.6
            $ # in project dir run pyenv local
            $ pyenv local system 3.4.9 3.5.6
        
        .. _`pyenv`: https://github.com/pyenv/pyenv/
        
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Requires-Python: >=2.7.9, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, <4
