amenezes/isilon-client

# Object Storage API

## Reference

- [openstack object storage API](https://docs.openstack.org/api-ref/object-store/)
- [cors](https://docs.openstack.org/swift/latest/cors.html)

## Usage

Default values from `IsilonClient`.

```txt
# environment variables
ISILON_ADDRESS=http://localhost:8080
ISILON_ACCOUNT=test
ISILON_USER=tester
ISILON_PASSWORD=testing
```

This values can be override setting environment variable or incluing in the class constructor.

```python
from isilon.client import IsilonClient


client = IsilonClient()
client
# IsilonClient(address='http://localhost:8080', account='test', user='tester', password='testing')

client.address
# default: 'http://localhost:8080'

client.account
# default: 'test'

client.user
# default: 'tester'

client.password
# default: 'testing'
)
```

## Discoverability

```python
# List activated capabilities
await client.discoverability.info()
```

## Accounts

```python
# Show account details and list containers.
await client.accounts.show()

# Create, update, or delete account metadata.
await client.accounts.update()

# Show account metadata.
await client.accounts.metadata()
```

## Containers

```python
# create container
await client.containers.create("my_container")

# show container details and list objects
await client.containers.objects("my_container")

# create, update or delete container metadata
metadata = {'X-Container-Meta-Test': "My metadata"}
await client.containers.update_metadata("my_container", headers=metadata)

# show container metadata
await client.containers.metadata("my_container")

# delete container
await client.containers.delete("my_container")
```

## Objects

```python
# Get object content and metadata.
# Use this method only for small objects
await client.objects.get("my_container". "my_object")

# Get large object content and metadata.
await client.objects.get_large("my_container", "my_remote_object", "my_object")

# Create or replace object
await client.objects.create("my_container", "my_remote_object", "my_object")

# Create or replace large object.
await client.objects.create_large("my_container", "my_remote_object", "my_object")

# Copy object.
# This call will raise NotImplementedError
await client.objects.copy("my_container", "my_remote_object", "my_object")

# Delete object.
await client.objects.delete("my_container", "my_remote_object", "my_object")

# Show object metadata.
await client.objects.show_metadata("my_container", "my_remote_object", "my_object")

# Create or update object metadata.
await client.objects.update_metadata("my_container", "my_remote_object", "my_object")
```

## Endpoints

```python
# List endpoints.
await client.endpoints()
```