Microsoft Azure Storage Blob Client Library for Python
Project description
Microsoft Azure Storage SDK for 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:
pip freezeIf you see azure==0.11.0 (or any version below 1.0), uninstall it first then install it again:
pip uninstall azure
pip install azureIf 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:
pip freezeIf you see azure-storage==0.36.0 (or any version below 0.36.0), uninstall it first:
pip uninstall azure-storageFeatures
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:
# Basic configuration: configure the root logger, including 'azure.storage'
logging.basicConfig(format='%(asctime)s %(name)-20s %(levelname)-5s %(message)s', level=logging.INFO)# 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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file azure-storage-blob-1.4.0.tar.gz.
File metadata
- Download URL: azure-storage-blob-1.4.0.tar.gz
- Upload date:
- Size: 71.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.20.1 setuptools/40.0.0 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.7.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 65ebe2e54460566c2077c6b3773a2a0623eabc7b95602010cb51b84077087fda |
|
| MD5 | 9053355ea6ff35521f670cddcb8bcb34 |
|
| BLAKE2b-256 | f05559ceddf35a312bd5d2b279096502ca460e312a1b33fa5706b198ec08cbbf |
File details
Details for the file azure_storage_blob-1.4.0-py2.py3-none-any.whl.
File metadata
- Download URL: azure_storage_blob-1.4.0-py2.py3-none-any.whl
- Upload date:
- Size: 75.4 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.20.1 setuptools/40.0.0 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.7.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | baa828607e21e5c7b6ceb2ede9894d465adf586373c2f7c988fe55eca8e9048c |
|
| MD5 | 5a2fcce08bc2a14ba1b1c58b82bfe950 |
|
| BLAKE2b-256 | f7b79b20c39bf411e896d110d01f2551e6e7b397fde6eb06b07293fe29705d13 |
