Skip to main content
Warning: You are using the test version of PyPI. This is a pre-production deployment of Warehouse. Changes made here affect the production instance of TestPyPI (testpypi.python.org).
Help us improve Python packaging - Donate today!

Python client library for SandCage's API

Project Description

sandcage-api-python is a python library for interfacing with SandCage’s API. The API documentation can be found at SandCage’s API documentation

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.

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

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.
  • 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.

Release History

Release History

This version
History Node

0.2.4

History Node

0.2.3

History Node

0.2.2

History Node

0.2.1

History Node

0.2.0

Download Files

Download Files

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

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
sandcage-0.2.4-py2.py3-none-any.whl (5.3 kB) Copy SHA256 Checksum SHA256 2.7 Wheel Oct 27, 2016
sandcage-0.2.4.tar.gz (4.0 kB) Copy SHA256 Checksum SHA256 Source Oct 27, 2016

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting