README.rst
1Microsoft Azure Storage SDK for Python
2======================================
3
4This project provides a client library in Python that makes it easy to
5consume Microsoft Azure Storage services. For documentation please see
6the Microsoft Azure `Python Developer Center`_ and our `API Reference`_ Page.
7
8 If you are looking for the Service Bus or Azure Management
9 libraries, please visit
10 https://github.com/Azure/azure-sdk-for-python.
11
12
13Compatibility
14=============
15
16**IMPORTANT**: If you have an earlier version of the azure package
17(version < 1.0), you should uninstall it before installing this package.
18
19You can check the version using pip:
20
21.. code:: shell
22
23 pip freeze
24
25If you see azure==0.11.0 (or any version below 1.0), uninstall it first then install it again:
26
27.. code:: shell
28
29 pip uninstall azure
30 pip install azure
31
32If you are upgrading from a version older than 0.30.0, see the upgrade doc, the
33usage samples in the samples directory, and the ChangeLog and BreakingChanges.
34
35If you are encountering `problems`_ installing azure-storage on Azure Web Apps,
36`upgrading pip`_ might help.
37
38
39Features
40========
41
42- Blob
43
44 - Create/Read/Update/Delete Containers
45 - Create/Read/Update/Delete Blobs
46 - Advanced Blob Operations
47
48- Queue
49
50 - Create/Delete Queues
51 - Insert/Peek Queue Messages
52 - Advanced Queue Operations
53
54- Table
55
56 - Create/Read/Update/Delete Tables
57 - Create/Read/Update/Delete Entities
58 - Batch operations
59 - Advanced Table Operations
60
61- Files
62
63 - Create/Update/Delete Shares
64 - Create/Update/Delete Directories
65 - Create/Read/Update/Delete Files
66 - Advanced File Operations
67
68Getting Started
69===============
70
71Download
72--------
73
74Option 1: Via PyPi
75~~~~~~~~~~~~~~~~~~
76
77To install via the Python Package Index (PyPI), type:
78::
79
80 pip install azure-storage
81
82Option 2: Source Via Git
83~~~~~~~~~~~~~~~~~~~~~~~~
84
85To get the source code of the SDK via git just type:
86
87::
88
89 git clone git://github.com/Azure/azure-storage-python.git
90 cd ./azure-storage-python
91 python setup.py install
92
93Option 3: Source Zip
94~~~~~~~~~~~~~~~~~~~~
95
96Download a zip of the code via GitHub or PyPi. Then, type:
97
98::
99
100 cd ./azure-storage-python
101 python setup.py install
102
103Minimum Requirements
104--------------------
105
106- Python 2.7, 3.3, 3.4, or 3.5.
107- See setup.py for dependencies
108
109Usage
110-----
111
112To use this SDK to call Microsoft Azure storage services, you need to
113first `create an account`_.
114
115Code Sample
116-----------
117
118See the samples directory for blob, queue, table, and file usage samples.
119
120Need Help?
121==========
122
123Be sure to check out the Microsoft Azure `Developer Forums on MSDN`_ or
124the `Developer Forums on Stack Overflow`_ if you have trouble with the
125provided code.
126
127Contribute Code or Provide Feedback
128===================================
129
130If you would like to become an active contributor to this project, please
131follow the instructions provided in `Azure Projects Contribution
132Guidelines`_. You can find more details for contributing in the `CONTRIBUTING.md doc`_.
133
134If you encounter any bugs with the library, please file an issue in the
135`Issues`_ section of the project.
136
137Learn More
138==========
139
140- `Python Developer Center`_
141- `Azure Storage Service`_
142- `Azure Storage Team Blog`_
143- `API Reference`_
144
145.. _Python Developer Center: http://azure.microsoft.com/en-us/develop/python/
146.. _API Reference: https://azure-storage.readthedocs.io/en/latest/
147.. _here: https://github.com/Azure/azure-storage-python/archive/master.zip
148.. _create an account: https://account.windowsazure.com/signup
149.. _Developer Forums on MSDN: http://social.msdn.microsoft.com/Forums/windowsazure/en-US/home?forum=windowsazuredata
150.. _Developer Forums on Stack Overflow: http://stackoverflow.com/questions/tagged/azure+windows-azure-storage
151.. _Azure Projects Contribution Guidelines: http://azure.github.io/guidelines.html
152.. _Issues: https://github.com/Azure/azure-storage-python/issues
153.. _Azure Storage Service: http://azure.microsoft.com/en-us/documentation/services/storage/
154.. _Azure Storage Team Blog: http://blogs.msdn.com/b/windowsazurestorage/
155.. _CONTRIBUTING.md doc: CONTRIBUTING.md
156.. _problems: https://github.com/Azure/azure-storage-python/issues/219
157.. _upgrading pip: https://docs.microsoft.com/en-us/visualstudio/python/managing-python-on-azure-app-service