Reference

tucuxi.__main__

Tucuxi!

class tucuxi.S3(bucket_name, session=None, config=None)

S3 Client.

get_object(obj_key, retries=0)

[summary]

Parameters

  • obj_key (str) – [description]

  • retries (int) – [description]. Defaults to 0.

Returns

[description]

Return type

Any

get_size(obj_key)

[summary]

Parameters

obj_key (str) – [description]

Returns

[description]

Return type

Any

list_objects(prefix=None, delimiter=None)

[summary]

Parameters

  • prefix (Optional[str]) – [description]. Defaults to None.

  • delimiter (Optional[str]) – [description]. Defaults to None.

Yields

Generator[str] – [description]

Return type

Generator[str, None, None]

set_object(obj_key, obj_data)

[summary]

Parameters

  • obj_key (str) – [description]

  • obj_data (Any) – [description]

Returns

[description]

Return type

Any

view_tree(start='', ident=4, _level=0)

[summary]

Parameters

  • start (str) – [description]. Defaults to “”.

  • ident (int) – [description]. Defaults to 4.

  • _level (int) – [description]. Defaults to 0.

Return type

None

class tucuxi.Session(access_key=None, secret_access=None, region_name=None, profile_name=None)

AWS Session Client.

get_session()

[summary]

Returns

[description]

Return type

Any

s3(bucket_name, **kwargs)

[summary]

Parameters

  • bucket_name (str) – Name of the S3 Bucket.

  • kwargs (Any) – Arbitrary keyword arguments.

Returns

[description]

Return type

Any

sqs(queue_url, region='us-east-1')

[summary]

Parameters

  • queue_url (str) – [description]

  • region (str) – [description]. Defaults to “us-east-1”.

Returns

[description]

Return type

Any

class tucuxi.Sqs(queue_url, region='us-east-1', session=None)

SQS Client.

delete_message(receipt_handle)

[summary]

Parameters

receipt_handle (str) – [description]

Returns

[description]

Return type

Any

delete_message_batch(receipts, raise_on_error=False)

[summary]

Parameters

  • receipts (List[str]) – [description]

  • raise_on_error (bool) – [description]. Defaults to False.

Returns

[description]

Return type

Dict[str, List[bool]]

listen(wait_time=0, max_number_of_messages=1, poll_interval=30, auto_delete=True)

[summary]

Parameters

  • wait_time (int) – [description]. Defaults to 0.

  • max_number_of_messages (int) – [description]. Defaults to 1.

  • poll_interval (int) – [description]. Defaults to 30.

  • auto_delete (bool) – [description]. Defaults to True.

Yields

Generator[tuple] – [description]

Return type

Generator[Tuple[str, Any], None, None]

send_message(message, delay=10)

[summary]

Parameters

  • message (Any) – [description]

  • delay (int) – [description]. Defaults to 10.

Returns

[description]

Return type

Any

send_message_batch(messages, raise_on_error=False)

[summary]

Parameters

  • messages (List[Any]) – [description]

  • raise_on_error (bool) – [description]. Defaults to False.

Returns

[description]

Return type

Dict[str, List[bool]]