Skip to content

Fix READMEs in each package #470

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
zezha-msft merged 1 commit into from
Jun 28, 2018
Merged

Fix READMEs in each package #470

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 10 additions & 4 deletions azure-storage-blob/README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,14 @@
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`_ Page.
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
Expand All @@ -29,7 +34,7 @@ If you see azure==0.11.0 (or any version below 1.0), uninstall it first then ins
pip uninstall azure
pip install azure

If you are upgrading from a version older than 0.30.0, see the upgrade doc, the
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,
Expand Down Expand Up @@ -211,7 +216,8 @@ Learn More
- `API Reference`_

.. _Python Developer Center: http://azure.microsoft.com/en-us/develop/python/
.. _API Reference: https://azure-storage.readthedocs.io/en/latest/
.. _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
Expand All @@ -223,4 +229,4 @@ Learn More
.. _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
.. _cosmosdb: https://github.com/Azure/azure-cosmosdb-python
12 changes: 9 additions & 3 deletions azure-storage-common/README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,14 @@
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`_ Page.
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
Expand Down Expand Up @@ -211,7 +216,8 @@ Learn More
- `API Reference`_

.. _Python Developer Center: http://azure.microsoft.com/en-us/develop/python/
.. _API Reference: https://azure-storage.readthedocs.io/en/latest/
.. _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
Expand All @@ -223,4 +229,4 @@ Learn More
.. _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
.. _cosmosdb: https://github.com/Azure/azure-cosmosdb-python
12 changes: 9 additions & 3 deletions azure-storage-file/README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,14 @@
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`_ Page.
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
Expand Down Expand Up @@ -211,7 +216,8 @@ Learn More
- `API Reference`_

.. _Python Developer Center: http://azure.microsoft.com/en-us/develop/python/
.. _API Reference: https://azure-storage.readthedocs.io/en/latest/
.. _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
Expand All @@ -223,4 +229,4 @@ Learn More
.. _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
.. _cosmosdb: https://github.com/Azure/azure-cosmosdb-python
12 changes: 9 additions & 3 deletions azure-storage-queue/README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,14 @@
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`_ Page.
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
Expand Down Expand Up @@ -211,7 +216,8 @@ Learn More
- `API Reference`_

.. _Python Developer Center: http://azure.microsoft.com/en-us/develop/python/
.. _API Reference: https://azure-storage.readthedocs.io/en/latest/
.. _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
Expand All @@ -223,4 +229,4 @@ Learn More
.. _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
.. _cosmosdb: https://github.com/Azure/azure-cosmosdb-python
6 changes: 3 additions & 3 deletions tool_validate_packages.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,9 +39,9 @@ def install_storage_package(executable_location, environment):
check_call([executable_location, 'install', 'azure-storage-queue', '-i',
'https://testpypi.python.org/pypi', '--no-deps'])
elif environment == 'prod':
check_call([executable_location, 'install', 'azure-storage-blob'])
check_call([executable_location, 'install', 'azure-storage-file'])
check_call([executable_location, 'install', 'azure-storage-queue'])
check_call([executable_location, 'install', 'azure-storage-blob', '--no-cache-dir'])
check_call([executable_location, 'install', 'azure-storage-file', '--no-cache-dir'])
check_call([executable_location, 'install', 'azure-storage-queue', '--no-cache-dir'])
else:
# install the namespace package first
nspkg_wheel = glob.glob("dist/*nspkg*.whl")
Expand Down