# main.py
from spaces import Client

client = Client(
  region_name = 'sfo3', # Required
  space_name = 'my_media', # Optional, can be set in spaces/env.yaml and/or be updated with <client>.set_space(space_name)
  public_key = 'foo', # Required, but can set key in spaces/env.yaml                                                                         
  secret_key = 'bar', # Required, but can set key in spaces/env.yaml

  # If any of region_name, public_key or secret_key are not provided, Client will override all values with env.yaml values.

)

# main.py
## Returns raw response content json
client.list_spaces()

## Readable version
print(
  client.list_spaces(
    string=True # Returns a fancy string
  )
)

# main.py
## Returns raw response content json
client.list_files(
  space_name=None # Optional if a space is already set
)

## Readable version
print(
  client.list_spaces(
    space_name=None # Optional if a space is already set
    string=True # Returns a fancy string
  )
)

## Search/list by path begins with 'foo', 'foo/', 'foo/bar.txt'
client.list_files(
    path="foo/"
    space_name=None # Optional if a space is already set
)

# main.py

client.download_file(
  file_name='foo/bar.txt'
  destination='downloads/' # Optional, should use a useful directory
  space_name=None # Optional if a space is already set
)

# Download to -> downloads/foo/bar.txt

# main.py

client.upload_file(
  file='my/pc/foo/bar.txt'
  destination='foo/' # Optional, should use a useful directory
  rename=None # Optional, file name only, no paths or extentions
  space_name=None # Optional if a space is already set
)

# Upload to -> foo/bar.txt

# Creates a Client object
Client<.__init__>(self, region_name=None, space_name=None, public_key=None, secret_key=None)

# Updates and stores available spaces
Client.refresh_spaces()

# Lists available spaces
Client.list_spaces(self, string=False)

# Sets active space
Client.set_space(self, space_name)

# Updates and stores available files
Client.refresh_files(self, space_name=None)

# Lists only the available directories
Client.list_dirs(self, path='', space_name=None, string=False)

# Lists only the available files
Client.list_files(self, path='', space_name=None, string=False)

# Lists all files and directories
Client.list_all(self, path='', space_name=None, string=False)

# Downloads specified file
Client.download_file(self, file_name, destination="downloads/", space_name=None)

# Uploads specified file
Client.upload_file(self, file, destination="", rename=None, space_name=None, extra_args={})
# extra_args: see https://boto3.amazonaws.com/v1/documentation/api/latest/guide/s3-uploading-files.html

# Deletes specified file
Client.delete_file(self, file_path, yes=False, space_name=None)

# Starts verbose shell
Client.shell(self)