newtera 1.0.0
Newtera Python SDK for Newtera TDM
License: Apache-2.0

# Newtera Python Client SDK for Newtera TDM service

The Newtera Python Client SDK provides high level APIs to access any Newtera TDM service.

This Quickstart Guide covers how to install the Newtera client SDK, connect to the Newtera TDM, and access the test data files.

The example below uses:
- [Python version 3.7+](https://www.python.org/downloads/) 
- The Newtera TDM local server

For a complete list of APIs and examples, see the [Python Client API Reference](http://newtera.net/docs/newtera/linux/developers/python/API.html)

## Install the Newtera Python SDK

The Python SDK requires Python version 3.7+.
You can install the SDK with `pip` or from the [`Newtera/Newtera-py` GitHub repository](https://github.com/yong-zhang-newtera/Newtera-py):

### Using `pip`

```sh
pip3 install Newtera
```

### Using Source From GitHub

```sh
git clone https://github.com/yong-zhang-newtera/Newtera-py
cd Newtera-py
python setup.py install
```

## Create a Newtera Client

To connect to the target service, create a Newtera client using the `Newtera()` method with the following required parameters:

| Parameter    | Description                                            |
|--------------|--------------------------------------------------------|
| `endpoint`   | URL of the target service.                             |
| `access_key` | Access key (user ID) of a user account in the service. |
| `secret_key` | Secret key (password) for the user account.            |

For example:

```py
from Newtera import Newtera

client = Newtera("localhost:8080",
    access_key="demo1",
    secret_key="888",
)
```

## Example - Upload a file

This example does the following:

- Connects to the Newtera TDM localhost server using the provided credentials.
- Uploads a file named `test-file.txt` from `/tmp`, renaming it `my-test-file.txt`.

### upload_file.py

```py
from Newtera import Newtera
from Newtera.error import NewteraError

def main():
    # Create a client with the Newtera server playground, its access key
    # and secret key.
    client = Newtera("localhost:8080",
        access_key="demo1",
        secret_key="888",
    )

    # The file to upload, change this path if needed
    source_file = "/tmp/test-file.txt"

    # The destination bucket and filename on the Newtera server
    bucket_name = "tdm"
	prefix = "task001/test-item001/data-packet001"
    destination_file = "my-test-file.txt"
    
    # Make the bucket if it doesn't exist.
    found = client.bucket_exists(bucket_name)
    if found:
        print("Bucket", bucket_name, "already exists")

    # Upload the file, renaming it in the process
    client.fput_object(
        bucket_name, prefix, destination_file, source_file,
    )
    print(
        source_file, "successfully uploaded as object",
        destination_file, "to bucket", bucket_name,
    )

if __name__ == "__main__":
    try:
        main()
    except NewteraError as exc:
        print("error occurred.", exc)
```

To run this example:

1. Create a file in `/tmp` named `test-file.txt`.
   To use a different path or filename, modify the value of `source_file`.

2. Run `upload_file.py` with the following command:

```sh
python upload_file.py
```