:mod:`neuron_morphology.pipeline.post_data_to_s3`
=================================================

.. py:module:: neuron_morphology.pipeline.post_data_to_s3


Module Contents
---------------


Functions
~~~~~~~~~

.. autoapisummary::

   neuron_morphology.pipeline.post_data_to_s3.get_credentials
   neuron_morphology.pipeline.post_data_to_s3.zip_files
   neuron_morphology.pipeline.post_data_to_s3.post_object_to_s3
   neuron_morphology.pipeline.post_data_to_s3.main


.. function:: get_credentials(credentials_file)

   get credentisals from credentials_file


   :Parameters:

       **credentials_file: file path to credentials_file**
           ..














   ..
       !! processed by numpydoc !!


.. function:: zip_files(file_dict)

   zip files into an archive in memory


   :Parameters:

       **file_dict: file name: file paths or file in bytes to be archived**
           ..














   ..
       !! processed by numpydoc !!


.. function:: post_object_to_s3(data, name, bucket, region, access_key_id=None, secret_access_key=None)

   post object (bytes) in memory to S3 bucket


   :Parameters:

       **data: the object data**
           ..

       **name: the object data's name in s3**
           ..

       **region: where the s3 bucket located**
           ..

       **bucket: s3 bucket name or arn**
           ..

       **access_key_id, secret_access_key: aws user's credentials**
           implicitly the credentials file located in ~/.aws/credentials or
           set AWS_SHARED_CREDENTIALS_FILE to the credentials file in your environment














   ..
       !! processed by numpydoc !!


.. function:: main()

   Usage:
   python post_data_to_s3.py --input_json INPUT_JSON
















   ..
       !! processed by numpydoc !!