Metadata-Version: 1.1
Name: sandcage
Version: 0.2.0
Summary: Python client library for SandCage's API
Home-page: https://github.com/sandcage/sandcage-api-python
Author: Antti Nykanen <ajjn@iki.fi>, Evangelos Kokkonos
Author-email: ajjn@iki.fi
License: Apache License Version 2.0
Description: .. image:: https://d18m5nnl28b2pp.cloudfront.net/p/a/img/header.png
        
        -------------------------------------------------------------------
        
        
        .. image:: https://scrutinizer-ci.com/g/sandcage/sandcage-api-python/badges/quality-score.png?b=master
            :target: https://scrutinizer-ci.com/g/sandcage/sandcage-api-python/?branch=master
        .. image:: https://travis-ci.org/sandcage/sandcage-api-python.svg?branch=master
            :target: https://travis-ci.org/sandcage/sandcage-api-python
        
        sandcage-api-python is a python library for interfacing with SandCage's API. The API documentation can be found at `SandCage's API documentation <https://www.sandcage.com/docs/0.2/>`_
        
        
        
        Requirements
        ------------
        - certifi
        - requests
        
        In order to use the library you need a SandCage API Key. Once logged into SandCage, you can get your API Key from `here <https://www.sandcage.com/panel/api_key>`_.
        
        Install
        -------
        Using pip::
        
          pip install sandcage
        
        or alternatively clone and install::
        
          git clone https://github.com/sandcage/sandcage-api-python
          cd sandcage-api-python
          python setup.py install
        
        Usage
        -----
        
        Simply::
          
          from sandcage import SandCage
        
          sc = SandCage('[YOUR_SANDCAGE_API_KEY]')
          sc.list_files_service()
        
        See more `examples <https://github.com/sandcage/sandcage-api-python/examples>`_
        
        To not include YOUR_SANDCAGE_API_KEY into your code you can for example save it as a file named SANDCAGE_API_KEY into your home directory::
        
          cd ~
          echo YOUR_SANDCAGE_API_KEY > SANDCAGE_API_KEY
        
        and then use the following code to initialize SandCage::
        
          import os.path
          from sandcage import SandCage
        
          api_key_dir = os.path.expanduser('~')
          api_key_file = os.path.join(api_key_dir, 'SANDCAGE_API_KEY')
          with open(api_key_file, 'r') as f:
              api_key = f.readline()
        
          sc = SandCage(api_key=api_key)
        
        Contributing
        ------------
        
        We are open to suggestions and code revisions, however there are some rules and limitations that you might want to consider first.
        
        - Code that you contribute will automatically be licensed under the `Apache License Version 2.0 <https://github.com/sandcage/sandcage-api-python/blob/master/LICENSE>`_.
        - Third party code will be reviewed, tested and possibly modified before being released.
        
        These basic rules help ensure that this code remains Open Source and compatible with Apache 2.0 license. All contributions will be added to the changelog and appear in every release.
        
Keywords: api http development
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.2
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
