Skip to main content
Help improve PyPI by participating in a 5-minute user interface survey!

Data-driven NIFCLOUD SDK for Python (Developer Preview)

Project Description

# NIFCLOUD SDK for Python (Developer Preview)

[![Build Status](https://travis-ci.org/nifcloud/nifcloud-sdk-python.svg?branch=master)](https://travis-ci.org/nifcloud/nifcloud-sdk-python)
[![Documentation](https://readthedocs.org/projects/nifcloud-sdk-python/badge)](https://nifcloud-sdk-python.readthedocs.io/en/latest/)
[![PyPI](https://badge.fury.io/py/nifcloud.svg)](https://pypi.python.org/pypi/nifcloud)

The **NIFCLOUD SDK for Python (Develper Preview)** is data-driven SDK.
It works by feeding AWS-SDK-compatible model JSONs to botocore module.

## Features

* :heavy_check_mark: Full support for NIFCLOUD Computing / RDB / NAS / Script APIs (as of Nov 13, 2017)
* :heavy_check_mark: Useful CLI tool for debugging
* :heavy_check_mark: AWS-SDK-compatible data-driven architecture

## Requirements

* Python 2.6 or later

## How to Install

```
pip install nifcloud
```

## Usage

Write your python program:

```python
from nifcloud import session

client = session.get_session().create_client(
"computing",
region_name="jp-east-1",
aws_access_key_id="<Your NIFCLOUD Access Key ID>",
aws_secret_access_key="<Your NIFCLOUD Secret Access Key>"
)

print(client.describe_instances())
```

Execute the program:

```
$ python test.py
```

Credentials and region name can be also passed via environment variables.

```python
from nifcloud import session

client = session.get_session().create_client("computing")
print(client.describe_instances())
```

```
$ export AWS_ACCESS_KEY_ID=<Your NIFCLOUD Access Key ID>
$ export AWS_SECRET_ACCESS_KEY=<Your NIFCLOUD Secret Access Key>
$ export AWS_DEFAULT_REGION=jp-east-1
$ python test.py
```

See [documentation](https://nifcloud-sdk-python.readthedocs.io/en/latest/) for detail.

## Debug with CLI

`nifcloud` module comes with `nifcloud-debugcli` command. You can use it like below:

```
## Set credentials and default region
$ export AWS_ACCESS_KEY_ID=<Your NIFCLOUD Access Key ID>
$ export AWS_SECRET_ACCESS_KEY=<Your NIFCLOUD Secret Access Key>
$ export AWS_DEFAULT_REGION=jp-east-1

## Show available services
$ nifcloud-debugcli help

## Show available actions for the service
$ nifcloud-debugcli computing help

## Show available parameters for the action
$ nifcloud-debugcli computing create-key-pair help

## Run the command actually
$ nifcloud-debugcli computing create-key-pair --key-name foobar123 --password foobar123
```

## Notes for Developer Preview

* It is not recommended to integrate this module into production systems.
* There will be some request parameters which can not be specified, and response items which can not be retrieved.
* Significant change of the specification will be made without any notice.

## License

See [LICENSE.txt](LICENSE.txt).


Release history Release notifications

This version
History Node

0.1.3

History Node

0.1.2

History Node

0.1.1

Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
nifcloud-0.1.3-py2.py3-none-any.whl (50.0 kB) Copy SHA256 hash SHA256 Wheel py2.py3 Apr 6, 2018
nifcloud-0.1.3.tar.gz (6.5 kB) Copy SHA256 hash SHA256 Source None Apr 6, 2018

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page