iot-storage-client


Nameiot-storage-client JSON
Version 1.1.5 PyPI version JSON
download
home_page
SummaryIoT Storage Client Library for Python
upload_time2022-08-16 03:08:08
maintainer
docs_urlNone
authorDylan Gonzales
requires_python>=3.7
licenseMIT License
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # iot-storage-client

[![python version](https://img.shields.io/badge/python_v3.9-blue?logo=python&logoColor=yellow)](https://img.shields.io/badge/python_v3.9-blue?logo=python&logoColor=yellow) [![pre-commit](https://img.shields.io/badge/pre--commit-blue?logo=pre-commit&logoColor=FAB040)](https://img.shields.io/badge/pre--commit-blue?logo=pre-commit&logoColor=FAB040) [![Keep a Changelog](https://img.shields.io/badge/keep_a_changelog-blue?logo=keepachangelog&logoColor=E05735)](https://img.shields.io/badge/keep_a_changelog-blue?logo=keepachangelog&logoColor=E05735) [![CI_CD GitHub_Actions](https://img.shields.io/badge/GitHub_Actions-blue?logo=githubactions&logoColor=black)](https://img.shields.io/badge/GitHub_Actions-blue?logo=githubactions&logoColor=black) [![package PyPI](https://img.shields.io/badge/PyPI-blue?logo=PyPI&logoColor=yellow)](https://img.shields.io/badge/PyPI-blue?logo=pypi&logoColor=yellow) [![azure-storage-blob](https://img.shields.io/badge/azure_storage_blob_v12.13.1-blue?logo=microsoft-azure&logoColor=black)](https://img.shields.io/badge/azure_storage_blob_v12.13.1-blue?logo=microsoft-azure&logoColor=black)

This package is a wrapper around the [azure-storage-blob](https://pypi.org/project/azure-storage-blob/) SDK to provide an asynchronous and synchronous client for interacting with Azure storage accounts in the cloud and on the edge.

[Official Documentation](https://py-iot-utils.azurewebsites.net/packages/iotStorageClient) ([async version](https://py-iot-utils.azurewebsites.net/packages/iotStorageClientAsync)) | [Source code](https://github.com/dgonzo27/py-iot-utils/tree/master/iot-storage-client) | [Package PyPI](https://pypi.org/project/iot-storage-client/)

## Table of Contents

- [Versioning](#versioning)
- [Getting Started](#getting-started)
  - [Prerequisites](#prerequisites)
  - [Basic Examples](#basic-examples)

## Versioning

This repository adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). It will be maintained through the `CHANGELOG.md` and in GitHub Releases. **It's important to note** that you must maintain the version with your releases in `iot/storage/client/_version.py`, otherwise a new package version will fail to get published.

## Getting Started

This section provides basic examples with the `iot-storage-client`.

### Prerequisites

- Python 3.7 or later is required to use this package.

- You must have an Azure subscription and Azure storage account to use this package.

### Basic Examples

1. Install via [pip](https://pypi.org/project/pip/):

   ```sh
   pip install iot-storage-client
   ```

2. Import and say hello:

   ```python
   from iot.storage.client import __version__


   print(f"hello world from iot-storage-client version: {__version__}")
   ```

3. Basic usage:

   ```python
   import tempfile

   from iot.storage.client import CredentialType, LocationType, IoTStorageClient

   # instantiate client
   storage_client = IoTStorageClient(
       credential_type=CredentialType.ACCOUNT_KEY,
       location_type=LocationType.CLOUD_BASED,
       account_name="myAzBlobStorageAcctName",
       credential="myBlobPrimaryKey***"
   )

   # print info w/ repr
   print(f"{storage_client.__repr__()}")

   # download blob to tempfile
   temp_file = tempfile.NamedTemporaryFile()
   download_result = storage_client.download_file(
       container_name="myAzBlobContainerName",
       source="path/to/blob.txt",
       dest=temp_file.name,
   )
   if not download_result:
       print("unable to download file")
       temp_file.close()
       raise

   # upload tempfile to blob
   upload_result = storage_client.upload_file(
       container_name="myAzBlobContainerName",
       source=temp_file.name,
       dest="path/to/new/blob.txt",
   )
   if not upload_result:
       print("unable to upload file")
       temp_file.close()
       raise

   # clean-up local memory
   temp_file.close()
   ```

4. Basic async usage:

   ```python
   import tempfile

   from iot.storage.client import CredentialType, LocationType, IoTStorageClientAsync

   # instantiate client
   storage_client = IoTStorageClientAsync(
       credential_type=CredentialType.ACCOUNT_KEY,
       location_type=LocationType.CLOUD_BASED,
       account_name="myAzBlobStorageAcctName",
       credential="myBlobPrimaryKey***"
   )

   # print info w/ repr
   print(f"{storage_client.__repr__()}")

   # download blob to tempfile
   temp_file = tempfile.NamedTemporaryFile()
   download_result = await storage_client.download_file(
       container_name="myAzBlobContainerName",
       source="path/to/blob.txt",
       dest=temp_file.name,
   )
   if not download_result:
       print("unable to download file")
       temp_file.close()
       raise

   # upload tempfile to blob
   upload_result = await storage_client.upload_file(
       container_name="myAzBlobContainerName",
       source=temp_file.name,
       dest="path/to/new/blob.txt",
   )
   if not upload_result:
       print("unable to upload file")
       temp_file.close()
       raise

   # clean-up local memory
   temp_file.close()
   ```

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "iot-storage-client",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": "",
    "keywords": "",
    "author": "Dylan Gonzales",
    "author_email": "py.iot.utils@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/d7/cf/0a90a233a6fce84459c4787dfc74d945593851d476cddbc1b9386948a914/iot-storage-client-1.1.5.tar.gz",
    "platform": null,
    "description": "# iot-storage-client\n\n[![python version](https://img.shields.io/badge/python_v3.9-blue?logo=python&logoColor=yellow)](https://img.shields.io/badge/python_v3.9-blue?logo=python&logoColor=yellow) [![pre-commit](https://img.shields.io/badge/pre--commit-blue?logo=pre-commit&logoColor=FAB040)](https://img.shields.io/badge/pre--commit-blue?logo=pre-commit&logoColor=FAB040) [![Keep a Changelog](https://img.shields.io/badge/keep_a_changelog-blue?logo=keepachangelog&logoColor=E05735)](https://img.shields.io/badge/keep_a_changelog-blue?logo=keepachangelog&logoColor=E05735) [![CI_CD GitHub_Actions](https://img.shields.io/badge/GitHub_Actions-blue?logo=githubactions&logoColor=black)](https://img.shields.io/badge/GitHub_Actions-blue?logo=githubactions&logoColor=black) [![package PyPI](https://img.shields.io/badge/PyPI-blue?logo=PyPI&logoColor=yellow)](https://img.shields.io/badge/PyPI-blue?logo=pypi&logoColor=yellow) [![azure-storage-blob](https://img.shields.io/badge/azure_storage_blob_v12.13.1-blue?logo=microsoft-azure&logoColor=black)](https://img.shields.io/badge/azure_storage_blob_v12.13.1-blue?logo=microsoft-azure&logoColor=black)\n\nThis package is a wrapper around the [azure-storage-blob](https://pypi.org/project/azure-storage-blob/) SDK to provide an asynchronous and synchronous client for interacting with Azure storage accounts in the cloud and on the edge.\n\n[Official Documentation](https://py-iot-utils.azurewebsites.net/packages/iotStorageClient) ([async version](https://py-iot-utils.azurewebsites.net/packages/iotStorageClientAsync)) | [Source code](https://github.com/dgonzo27/py-iot-utils/tree/master/iot-storage-client) | [Package PyPI](https://pypi.org/project/iot-storage-client/)\n\n## Table of Contents\n\n- [Versioning](#versioning)\n- [Getting Started](#getting-started)\n  - [Prerequisites](#prerequisites)\n  - [Basic Examples](#basic-examples)\n\n## Versioning\n\nThis repository adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). It will be maintained through the `CHANGELOG.md` and in GitHub Releases. **It's important to note** that you must maintain the version with your releases in `iot/storage/client/_version.py`, otherwise a new package version will fail to get published.\n\n## Getting Started\n\nThis section provides basic examples with the `iot-storage-client`.\n\n### Prerequisites\n\n- Python 3.7 or later is required to use this package.\n\n- You must have an Azure subscription and Azure storage account to use this package.\n\n### Basic Examples\n\n1. Install via [pip](https://pypi.org/project/pip/):\n\n   ```sh\n   pip install iot-storage-client\n   ```\n\n2. Import and say hello:\n\n   ```python\n   from iot.storage.client import __version__\n\n\n   print(f\"hello world from iot-storage-client version: {__version__}\")\n   ```\n\n3. Basic usage:\n\n   ```python\n   import tempfile\n\n   from iot.storage.client import CredentialType, LocationType, IoTStorageClient\n\n   # instantiate client\n   storage_client = IoTStorageClient(\n       credential_type=CredentialType.ACCOUNT_KEY,\n       location_type=LocationType.CLOUD_BASED,\n       account_name=\"myAzBlobStorageAcctName\",\n       credential=\"myBlobPrimaryKey***\"\n   )\n\n   # print info w/ repr\n   print(f\"{storage_client.__repr__()}\")\n\n   # download blob to tempfile\n   temp_file = tempfile.NamedTemporaryFile()\n   download_result = storage_client.download_file(\n       container_name=\"myAzBlobContainerName\",\n       source=\"path/to/blob.txt\",\n       dest=temp_file.name,\n   )\n   if not download_result:\n       print(\"unable to download file\")\n       temp_file.close()\n       raise\n\n   # upload tempfile to blob\n   upload_result = storage_client.upload_file(\n       container_name=\"myAzBlobContainerName\",\n       source=temp_file.name,\n       dest=\"path/to/new/blob.txt\",\n   )\n   if not upload_result:\n       print(\"unable to upload file\")\n       temp_file.close()\n       raise\n\n   # clean-up local memory\n   temp_file.close()\n   ```\n\n4. Basic async usage:\n\n   ```python\n   import tempfile\n\n   from iot.storage.client import CredentialType, LocationType, IoTStorageClientAsync\n\n   # instantiate client\n   storage_client = IoTStorageClientAsync(\n       credential_type=CredentialType.ACCOUNT_KEY,\n       location_type=LocationType.CLOUD_BASED,\n       account_name=\"myAzBlobStorageAcctName\",\n       credential=\"myBlobPrimaryKey***\"\n   )\n\n   # print info w/ repr\n   print(f\"{storage_client.__repr__()}\")\n\n   # download blob to tempfile\n   temp_file = tempfile.NamedTemporaryFile()\n   download_result = await storage_client.download_file(\n       container_name=\"myAzBlobContainerName\",\n       source=\"path/to/blob.txt\",\n       dest=temp_file.name,\n   )\n   if not download_result:\n       print(\"unable to download file\")\n       temp_file.close()\n       raise\n\n   # upload tempfile to blob\n   upload_result = await storage_client.upload_file(\n       container_name=\"myAzBlobContainerName\",\n       source=temp_file.name,\n       dest=\"path/to/new/blob.txt\",\n   )\n   if not upload_result:\n       print(\"unable to upload file\")\n       temp_file.close()\n       raise\n\n   # clean-up local memory\n   temp_file.close()\n   ```\n",
    "bugtrack_url": null,
    "license": "MIT License",
    "summary": "IoT Storage Client Library for Python",
    "version": "1.1.5",
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "6beabccce3c94d610e8bed249acd5215",
                "sha256": "f43d509c606d9b335a123e28dae0e20cbd13e9e04beb3f8cf8bd819a4e5b596a"
            },
            "downloads": -1,
            "filename": "iot_storage_client-1.1.5-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "6beabccce3c94d610e8bed249acd5215",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7",
            "size": 10884,
            "upload_time": "2022-08-16T03:08:07",
            "upload_time_iso_8601": "2022-08-16T03:08:07.242786Z",
            "url": "https://files.pythonhosted.org/packages/20/f4/2317219b94df2228821a56b949599976cf06e09ac428eae0548fb27c1022/iot_storage_client-1.1.5-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "f0af55c4636a1d8067a5ec13a7e2da11",
                "sha256": "a75f475dbf5a8e291b3b453fc6d6c918d6477763975453fa8f7f261997fa9ce9"
            },
            "downloads": -1,
            "filename": "iot-storage-client-1.1.5.tar.gz",
            "has_sig": false,
            "md5_digest": "f0af55c4636a1d8067a5ec13a7e2da11",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 9531,
            "upload_time": "2022-08-16T03:08:08",
            "upload_time_iso_8601": "2022-08-16T03:08:08.513724Z",
            "url": "https://files.pythonhosted.org/packages/d7/cf/0a90a233a6fce84459c4787dfc74d945593851d476cddbc1b9386948a914/iot-storage-client-1.1.5.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2022-08-16 03:08:08",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "lcname": "iot-storage-client"
}
        
Elapsed time: 0.49021s