-
Notifications
You must be signed in to change notification settings - Fork 3.2k
Adjust README with comments from the per-release doc review. #11110
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.
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
KieranBrantnerMagee
merged 4 commits into
Azure:master
from
KieranBrantnerMagee:kibrantn/servicebus/track2-preview2-readme-cleanup
Apr 29, 2020
Merged
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
c17f923
Adjust README with comments from the per-release doc review.
KieranBrantnerMagee 93f4e2f
Make 0.50 doc links more specific.
KieranBrantnerMagee fc12906
Update sdk/servicebus/azure-servicebus/README.md
KieranBrantnerMagee 7c80739
updates versions specified in readme
KieranBrantnerMagee File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -11,10 +11,15 @@ Use the Service Bus client library for Python to communicate between application | |
| * Send and receive messages within your Service Bus channels. | ||
| * Utilize message locks, sessions, and dead letter functionality to implement complex messaging patterns. | ||
|
|
||
| Note: This is a preview release of the Python Service Bus SDK, and is not yet at feature parity with version 0.50. Some functionality, such as topic and subscription utilization, will be arriving in upcoming Preview releases; Thank you for your patience and interest as we roll out these changes. | ||
|
|
||
| [Source code](./) | [Package (PyPi)][pypi] | [API reference documentation][api_docs] | [Product documentation][product_docs] | [Samples](./samples) | [Changelog](./CHANGELOG.md) | ||
|
|
||
| > **NOTE**: This document has instructions, links and code snippets for the **preview** of the next version of the `azure-servicebus` package | ||
| > which has different APIs than the stable version (0.50). Please view the resources below for references on the existing library. | ||
|
|
||
| [V0.50 Source code][0_50_source] | [V0.50 Package (PyPi)][0_50_pypi] | [V0.50 API reference documentation][0_50_api_docs] | [V0.50 Product documentation][0_50_product_docs] | [V0.50 Samples][0_50_samples] | [V0.50 Changelog][0_50_changelog] | ||
|
|
||
| We also provide a migration guide for users familiar with the existing package that would like to try the preview: [migration guide to move from Service Bus V0.50 to Service Bus V7 Preview][migration_guide] | ||
|
|
||
| ## Getting started | ||
|
|
||
| ### Install the package | ||
|
|
@@ -94,7 +99,7 @@ Note: client can be initialized without a context manager, but must be manually | |
|
|
||
| Once you've initialized a `ServiceBusClient`, you can interact with the primary resource types within a Service Bus Namespace, of which multiple can exist and on which actual message transmission takes place, the namespace often serving as an application container: | ||
|
|
||
| * [Queue][queue_concept]: Allows for Sending and Receiving of messages, ordered first-in-first-out. Often used for point-to-point communication. | ||
| * [Queue][queue_concept]: Allows for Sending and Receiving of message. Often used for point-to-point communication. | ||
|
|
||
| * [Topic][topic_concept]: As opposed to Queues, Topics are better suited to publish/subscribe scenarios. A topic can be sent to, but requires a subscription, of which there can be multiple in parallel, to consume from. | ||
|
|
||
|
|
@@ -122,6 +127,7 @@ The following sections provide several code snippets covering some of the most c | |
|
|
||
| To perform management tasks such as creating and deleting queues/topics/subscriptions, please utilize the azure-mgmt-servicebus library, available [here][servicebus_management_repository]. | ||
|
|
||
| Please find further examples in the [samples](./samples) directory demonstrating common Service Bus scenarios such as sending, receiving, session management and message handling. | ||
|
|
||
| ### Send a message to a queue | ||
|
|
||
|
|
@@ -205,7 +211,7 @@ Please view the [exceptions](./azure/servicebus/exceptions.py) file for detailed | |
|
|
||
| ### More sample code | ||
|
|
||
| Please find further examples in the [samples](./samples) directory demonstrating common Service Bus scenarios such as sending, receiving, and message handling. | ||
| Please find further examples in the [samples](./samples) directory demonstrating common Service Bus scenarios such as sending, receiving, session management and message handling. | ||
|
|
||
| ### Additional documentation | ||
|
|
||
|
|
@@ -234,7 +240,7 @@ contact [[email protected]](mailto:[email protected]) with any additio | |
| [cloud_shell]: https://docs.microsoft.com/azure/cloud-shell/overview | ||
| [cloud_shell_bash]: https://shell.azure.com/bash | ||
| [pip]: https://pypi.org/project/pip/ | ||
| [pypi]: https://pypi.org/project/azure-servicebus/ | ||
| [pypi]: https://pypi.org/project/azure-servicebus/7.0.0b1/ | ||
KieranBrantnerMagee marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| [python]: https://www.python.org/downloads/ | ||
| [venv]: https://docs.python.org/3/library/venv.html | ||
| [virtualenv]: https://virtualenv.pypa.io | ||
|
|
@@ -251,3 +257,10 @@ contact [[email protected]](mailto:[email protected]) with any additio | |
| [servicebus_aad_authentication]: https://docs.microsoft.com/en-us/azure/service-bus-messaging/service-bus-authentication-and-authorization | ||
| [token_credential_interface]: ../../core/azure-core/azure/core/credentials.py | ||
| [pypi_azure_identity]: https://pypi.org/project/azure-identity/ | ||
| [0_50_source]: https://github.com/Azure/azure-sdk-for-python/tree/servicebus_v0.50.2/sdk/servicebus/azure-servicebus/ | ||
| [0_50_pypi]: https://pypi.org/project/azure-servicebus/ | ||
| [0_50_api_docs]:https://azuresdkdocs.blob.core.windows.net/$web/python/azure-servicebus/0.50.2/index.html | ||
| [0_50_product_docs]: https://docs.microsoft.com/azure/service-bus-messaging/ | ||
| [0_50_samples]: https://github.com/Azure/azure-sdk-for-python/tree/servicebus_v0.50.2/sdk/servicebus/azure-servicebus/samples | ||
| [0_50_changelog]: https://github.com/Azure/azure-sdk-for-python/blob/servicebus_v0.50.2/sdk/servicebus/azure-servicebus/CHANGELOG.md | ||
| [migration_guide]: ./migration_guide.md | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.