Metadata-Version: 2.1
Name: ezazure
Version: 0.0.5
Summary: easy azure interface for uploading & downloading files
Author: Mike Powell PhD
Author-email: mike@lakeslegendaries.com
License: MIT License
        
        Copyright (c) 2021 Lake's Legendaries LLC
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Platform: UNKNOWN
Requires-Python: >=3.7
License-File: LICENSE

#################################################################
ezazure: Easy Azure interface for uploading and downloading files
#################################################################

Azure's python interface for uploading and downloading files is complicated and
unintutive. :code:`ezazure` provides an easy interface to these
functionalities. 

To get started, check out the `docs <https://lakes-legendaries.github.io/ezazure/>`_!

If you will be contributing to this repo, check out the `developer's guide
<https://lakes-legendaries.github.io/ezazure/dev.html>`_.

**********
Quickstart
**********

#. Install this package:

   .. code-block:: bash

      pip install ezazure

#. Put your Azure connection string and container name in a :code:`.ezazure` file:

   .. code-block:: yaml

      connection_str: AZURE_CONNECTION_STRING
      container: CONTAINER_NAME

#. Run from the command line either of the following:

   .. code-block:: bash

      python -m ezazure --upload FNAME
      python -m ezazure --download FNAME

#. :code:`ezazure` supports regex pattern matching:

   .. code-block:: bash

      python -m ezazure --download --regex FNAME.*
      python -m ezazure --upload --regex PATH/FNAME[0-9]+\.csv

#. You can also use this package as an API:

   .. code-block:: python

      from ezazure import Azure


      azure = Azure()
      azure.upload(fname)
      azure.download(fname)


