Microsoft Azure Storage SDK for Python
======================================
.. image:: https://travis-ci.org/Azure/azure-storage-python.svg
:target: https://travis-ci.org/Azure/azure-storage-python
.. image:: https://img.shields.io/codecov/c/github/azure/azure-storage-python.svg
:target: https://codecov.io/gh/Azure/azure-storage-python
This project provides a client library in Python that makes it easy to
consume Microsoft Azure Storage services. For documentation please see
the Microsoft Azure `Python Developer Center`_ and our `API Reference`_ (also available on `readthedocs`_).
If you are looking for the Service Bus or Azure Management
libraries, please visit
https://github.com/Azure/azure-sdk-for-python.
Compatibility
=============
**IMPORTANT**: If you have an earlier version of the azure package
(version < 1.0), you should uninstall it before installing this package.
You can check the version using pip:
.. code:: shell
pip freeze
If you see azure==0.11.0 (or any version below 1.0), uninstall it first then install it again:
.. code:: shell
pip uninstall azure
pip install azure
If you are upgrading from a version older than 0.30.0, see the upgrade doc, the
usage samples in the samples directory, and the ChangeLog and BreakingChanges.
If you are encountering `problems`_ installing azure storage on Azure Web Apps,
`upgrading pip`_ might help.
**IMPORTANT**: If you have an earlier version of the azure-storage package
(version <= 0.36.0), you should uninstall it before installing the new split packages.
You can check the version using pip:
.. code:: shell
pip freeze
If you see azure-storage==0.36.0 (or any version below 0.36.0), uninstall it first:
.. code:: shell
pip uninstall azure-storage
Features
========
- Blob
- Create/Read/Update/Delete Containers
- Create/Read/Update/Delete Blobs
- Advanced Blob Operations
- Queue
- Create/Delete Queues
- Insert/Peek Queue Messages
- Advanced Queue Operations
- Files
- Create/Update/Delete Shares
- Create/Update/Delete Directories
- Create/Read/Update/Delete Files
- Advanced File Operations
Getting Started
===============
Download
--------
The Azure Storage SDK for Python is composed of 5 packages:
- azure-storage-blob
- Contains the blob service APIs.
- azure-storage-file
- Contains the file service APIs.
- azure-storage-queue
- Contains the queue service APIs.
- azure-storage-common
- Contains common code shared by blob, file and queue.
- azure-storage-nspkg
- Owns the azure.storage namespace, user should not use this directly.
**Note**: prior to and including version 0.36.0, there used to be a single package (azure-storage) containing all services.
It is no longer supported, and users should install the 3 before-mentioned service packages individually, depending on the need.
In addition, the **table** package is no longer releasing under the azure-storage namespace, please refer to `cosmosdb`_.
Option 1: Via PyPi
~~~~~~~~~~~~~~~~~~
To install via the Python Package Index (PyPI), type:
::
pip install azure-storage-blob
pip install azure-storage-file
pip install azure-storage-queue
Option 2: Source Via Git
~~~~~~~~~~~~~~~~~~~~~~~~
To get the source code of the SDK via git just type:
::
git clone git://github.com/Azure/azure-storage-python.git
cd ./azure-storage-python/azure-storage-nspkg
python setup.py install
cd ../azure-storage-common
python setup.py install
cd ../azure-storage-blob
python setup.py install
Replace azure-storage-blob with azure-storage-file or azure-storage-queue, to install the other services.
Option 3: Source Zip
~~~~~~~~~~~~~~~~~~~~
Download a zip of the code via GitHub or PyPi. Then follow the same instructions in option 2.
Minimum Requirements
--------------------
- Python 2.7, 3.3, 3.4, 3.5, or 3.6.
- See setup.py for dependencies
Usage
-----
To use this SDK to call Microsoft Azure storage services, you need to
first `create an account`_.
Logging
-----------
To make debugging easier, it is recommended to turn on logging for the logger named 'azure.storage'.
Here are two example configurations:
.. code:: python
# Basic configuration: configure the root logger, including 'azure.storage'
logging.basicConfig(format='%(asctime)s %(name)-20s %(levelname)-5s %(message)s', level=logging.INFO)
.. code:: python
# More advanced configuration allowing more control
logger = logging.getLogger('azure.storage')
handler = logging.StreamHandler()
formatter = logging.Formatter('%(asctime)s %(name)-20s %(levelname)-5s %(message)s')
handler.setFormatter(formatter)
logger.addHandler(handler)
logger.setLevel(logging.INFO)
Here is how we use the logging levels, it is recommended to use INFO:
- DEBUG: log strings to sign
- INFO: log outgoing requests and responses, as well as retry attempts
- WARNING: not used
- ERROR: log calls that still failed after all the retries
Code Sample
-----------
See the samples directory for blob, queue, and file usage samples.
Need Help?
==========
Be sure to check out the Microsoft Azure `Developer Forums on MSDN`_ or
the `Developer Forums on Stack Overflow`_ if you have trouble with the
provided code.
Contribute Code or Provide Feedback
===================================
If you would like to become an active contributor to this project, please
follow the instructions provided in `Azure Projects Contribution
Guidelines`_. You can find more details for contributing in the `CONTRIBUTING.md doc`_.
If you encounter any bugs with the library, please file an issue in the
`Issues`_ section of the project.
Learn More
==========
- `Python Developer Center`_
- `Azure Storage Service`_
- `Azure Storage Team Blog`_
- `API Reference`_
.. _Python Developer Center: http://azure.microsoft.com/en-us/develop/python/
.. _API Reference: https://docs.microsoft.com/en-us/python/api/overview/azure/storage/client?view=azure-python
.. _readthedocs: https://azure-storage.readthedocs.io/
.. _here: https://github.com/Azure/azure-storage-python/archive/master.zip
.. _create an account: https://account.windowsazure.com/signup
.. _Developer Forums on MSDN: http://social.msdn.microsoft.com/Forums/windowsazure/en-US/home?forum=windowsazuredata
.. _Developer Forums on Stack Overflow: http://stackoverflow.com/questions/tagged/azure+windows-azure-storage
.. _Azure Projects Contribution Guidelines: http://azure.github.io/guidelines.html
.. _Issues: https://github.com/Azure/azure-storage-python/issues
.. _Azure Storage Service: http://azure.microsoft.com/en-us/documentation/services/storage/
.. _Azure Storage Team Blog: http://blogs.msdn.com/b/windowsazurestorage/
.. _CONTRIBUTING.md doc: CONTRIBUTING.md
.. _problems: https://github.com/Azure/azure-storage-python/issues/219
.. _upgrading pip: https://docs.microsoft.com/en-us/visualstudio/python/managing-python-on-azure-app-service
.. _cosmosdb: https://github.com/Azure/azure-cosmosdb-python
Raw data
{
"_id": null,
"home_page": "https://github.com/Azure/azure-storage-python",
"name": "azure-storage-common",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "Microsoft Corporation",
"author_email": "ascl@microsoft.com",
"download_url": "https://files.pythonhosted.org/packages/48/12/e074fe454bc327fbe2a61e20d3260473ee4a0fd85387baf249dc83c8e774/azure-storage-common-2.1.0.tar.gz",
"platform": "",
"description": "Microsoft Azure Storage SDK for Python\n======================================\n\n.. image:: https://travis-ci.org/Azure/azure-storage-python.svg\n :target: https://travis-ci.org/Azure/azure-storage-python\n.. image:: https://img.shields.io/codecov/c/github/azure/azure-storage-python.svg\n :target: https://codecov.io/gh/Azure/azure-storage-python\n\nThis project provides a client library in Python that makes it easy to\nconsume Microsoft Azure Storage services. For documentation please see\nthe Microsoft Azure `Python Developer Center`_ and our `API Reference`_ (also available on `readthedocs`_).\n\n If you are looking for the Service Bus or Azure Management\n libraries, please visit\n https://github.com/Azure/azure-sdk-for-python.\n\n\nCompatibility\n=============\n\n**IMPORTANT**: If you have an earlier version of the azure package\n(version < 1.0), you should uninstall it before installing this package.\n\nYou can check the version using pip:\n\n.. code:: shell\n\n pip freeze\n\nIf you see azure==0.11.0 (or any version below 1.0), uninstall it first then install it again:\n\n.. code:: shell\n\n pip uninstall azure\n pip install azure\n\nIf you are upgrading from a version older than 0.30.0, see the upgrade doc, the \nusage samples in the samples directory, and the ChangeLog and BreakingChanges.\n\nIf you are encountering `problems`_ installing azure storage on Azure Web Apps,\n`upgrading pip`_ might help.\n\n**IMPORTANT**: If you have an earlier version of the azure-storage package\n(version <= 0.36.0), you should uninstall it before installing the new split packages.\n\nYou can check the version using pip:\n\n.. code:: shell\n\n pip freeze\n\nIf you see azure-storage==0.36.0 (or any version below 0.36.0), uninstall it first:\n\n.. code:: shell\n\n pip uninstall azure-storage\n\nFeatures\n========\n\n- Blob\n\n - Create/Read/Update/Delete Containers\n - Create/Read/Update/Delete Blobs\n - Advanced Blob Operations\n\n- Queue\n\n - Create/Delete Queues\n - Insert/Peek Queue Messages\n - Advanced Queue Operations\n\n- Files\n\n - Create/Update/Delete Shares\n - Create/Update/Delete Directories\n - Create/Read/Update/Delete Files\n - Advanced File Operations\n\nGetting Started\n===============\n\nDownload\n--------\n\nThe Azure Storage SDK for Python is composed of 5 packages:\n\n- azure-storage-blob\n\n - Contains the blob service APIs.\n\n- azure-storage-file\n\n - Contains the file service APIs.\n\n- azure-storage-queue\n\n - Contains the queue service APIs.\n\n- azure-storage-common\n\n - Contains common code shared by blob, file and queue.\n\n- azure-storage-nspkg\n\n - Owns the azure.storage namespace, user should not use this directly.\n\n**Note**: prior to and including version 0.36.0, there used to be a single package (azure-storage) containing all services.\nIt is no longer supported, and users should install the 3 before-mentioned service packages individually, depending on the need.\nIn addition, the **table** package is no longer releasing under the azure-storage namespace, please refer to `cosmosdb`_.\n\nOption 1: Via PyPi\n~~~~~~~~~~~~~~~~~~\n\nTo install via the Python Package Index (PyPI), type:\n::\n\n pip install azure-storage-blob\n pip install azure-storage-file\n pip install azure-storage-queue\n\nOption 2: Source Via Git\n~~~~~~~~~~~~~~~~~~~~~~~~\n\nTo get the source code of the SDK via git just type:\n\n::\n\n git clone git://github.com/Azure/azure-storage-python.git\n\n cd ./azure-storage-python/azure-storage-nspkg\n python setup.py install\n\n cd ../azure-storage-common\n python setup.py install\n\n cd ../azure-storage-blob\n python setup.py install\n\n\nReplace azure-storage-blob with azure-storage-file or azure-storage-queue, to install the other services.\n\nOption 3: Source Zip\n~~~~~~~~~~~~~~~~~~~~\n\nDownload a zip of the code via GitHub or PyPi. Then follow the same instructions in option 2.\n\nMinimum Requirements\n--------------------\n\n- Python 2.7, 3.3, 3.4, 3.5, or 3.6.\n- See setup.py for dependencies\n\nUsage\n-----\n\nTo use this SDK to call Microsoft Azure storage services, you need to\nfirst `create an account`_.\n\nLogging\n-----------\n\nTo make debugging easier, it is recommended to turn on logging for the logger named 'azure.storage'.\nHere are two example configurations:\n\n.. code:: python\n\n # Basic configuration: configure the root logger, including 'azure.storage'\n logging.basicConfig(format='%(asctime)s %(name)-20s %(levelname)-5s %(message)s', level=logging.INFO)\n\n.. code:: python\n\n # More advanced configuration allowing more control\n logger = logging.getLogger('azure.storage')\n handler = logging.StreamHandler()\n formatter = logging.Formatter('%(asctime)s %(name)-20s %(levelname)-5s %(message)s')\n handler.setFormatter(formatter)\n logger.addHandler(handler)\n logger.setLevel(logging.INFO)\n\nHere is how we use the logging levels, it is recommended to use INFO:\n\n- DEBUG: log strings to sign\n- INFO: log outgoing requests and responses, as well as retry attempts\n- WARNING: not used\n- ERROR: log calls that still failed after all the retries\n\nCode Sample\n-----------\n\nSee the samples directory for blob, queue, and file usage samples.\n\nNeed Help?\n==========\n\nBe sure to check out the Microsoft Azure `Developer Forums on MSDN`_ or\nthe `Developer Forums on Stack Overflow`_ if you have trouble with the\nprovided code.\n\nContribute Code or Provide Feedback\n===================================\n\nIf you would like to become an active contributor to this project, please\nfollow the instructions provided in `Azure Projects Contribution\nGuidelines`_. You can find more details for contributing in the `CONTRIBUTING.md doc`_.\n\nIf you encounter any bugs with the library, please file an issue in the\n`Issues`_ section of the project.\n\nLearn More\n==========\n\n- `Python Developer Center`_\n- `Azure Storage Service`_\n- `Azure Storage Team Blog`_\n- `API Reference`_\n\n.. _Python Developer Center: http://azure.microsoft.com/en-us/develop/python/\n.. _API Reference: https://docs.microsoft.com/en-us/python/api/overview/azure/storage/client?view=azure-python\n.. _readthedocs: https://azure-storage.readthedocs.io/\n.. _here: https://github.com/Azure/azure-storage-python/archive/master.zip\n.. _create an account: https://account.windowsazure.com/signup\n.. _Developer Forums on MSDN: http://social.msdn.microsoft.com/Forums/windowsazure/en-US/home?forum=windowsazuredata\n.. _Developer Forums on Stack Overflow: http://stackoverflow.com/questions/tagged/azure+windows-azure-storage\n.. _Azure Projects Contribution Guidelines: http://azure.github.io/guidelines.html\n.. _Issues: https://github.com/Azure/azure-storage-python/issues\n.. _Azure Storage Service: http://azure.microsoft.com/en-us/documentation/services/storage/\n.. _Azure Storage Team Blog: http://blogs.msdn.com/b/windowsazurestorage/\n.. _CONTRIBUTING.md doc: CONTRIBUTING.md\n.. _problems: https://github.com/Azure/azure-storage-python/issues/219\n.. _upgrading pip: https://docs.microsoft.com/en-us/visualstudio/python/managing-python-on-azure-app-service\n.. _cosmosdb: https://github.com/Azure/azure-cosmosdb-python\n\n\n",
"bugtrack_url": null,
"license": "MIT License",
"summary": "Microsoft Azure Storage Common Client Library for Python",
"version": "2.1.0",
"project_urls": {
"Homepage": "https://github.com/Azure/azure-storage-python"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6ba06794b318ce0118d1a4053bdf0149a60807407db9b710354f2b203c2f5975",
"md5": "2a1bc3a3c9d804497df3e46f5e6fb07f",
"sha256": "b01a491a18839b9d05a4fe3421458a0ddb5ab9443c14e487f40d16f9a1dc2fbe"
},
"downloads": -1,
"filename": "azure_storage_common-2.1.0-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "2a1bc3a3c9d804497df3e46f5e6fb07f",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 47778,
"upload_time": "2019-08-02T04:24:14",
"upload_time_iso_8601": "2019-08-02T04:24:14.670328Z",
"url": "https://files.pythonhosted.org/packages/6b/a0/6794b318ce0118d1a4053bdf0149a60807407db9b710354f2b203c2f5975/azure_storage_common-2.1.0-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "4812e074fe454bc327fbe2a61e20d3260473ee4a0fd85387baf249dc83c8e774",
"md5": "8b78fae1786098193ce21ddea0bf0157",
"sha256": "ccedef5c67227bc4d6670ffd37cec18fb529a1b7c3a5e53e4096eb0cf23dc73f"
},
"downloads": -1,
"filename": "azure-storage-common-2.1.0.tar.gz",
"has_sig": false,
"md5_digest": "8b78fae1786098193ce21ddea0bf0157",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 41869,
"upload_time": "2019-08-02T04:24:21",
"upload_time_iso_8601": "2019-08-02T04:24:21.763518Z",
"url": "https://files.pythonhosted.org/packages/48/12/e074fe454bc327fbe2a61e20d3260473ee4a0fd85387baf249dc83c8e774/azure-storage-common-2.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2019-08-02 04:24:21",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Azure",
"github_project": "azure-storage-python",
"travis_ci": true,
"coveralls": true,
"github_actions": false,
"requirements": [],
"lcname": "azure-storage-common"
}
JSON
