Skip to content
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

Jump to bottom

Update README of EventHub #6151

Merged
merged 12 commits into from
Jun 29, 2019
Merged

Update README of EventHub #6151

merged 12 commits into from
Jun 29, 2019

Conversation

yunhaoling
Copy link
Contributor

No description provided.

@yunhaoling yunhaoling requested a review from ramya-rao-a June 27, 2019 21:16
@adxsdk6
Copy link

adxsdk6 commented Jun 27, 2019

Can one of the admins verify this patch?

ramya-rao-a
ramya-rao-a suggested changes Jun 27, 2019
View reviewed changes
Copy link
Contributor

@ramya-rao-a ramya-rao-a left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • The "API reference documentation" link is pointing to Track 1 docs. Can we point this to the python docs that are getting generated from the central repo daily?
  • The "Get credentials" section is not very helpful. It only points to the portal home page. Updating this to refer to connection string instead of credentials and pointing to https://docs.microsoft.com/en-us/azure/event-hubs/event-hubs-get-connection-string would be more helpful
  • The code snippet for creating the client refers to use of various environment variable for Event Hubs details. I don't believe this is something we decided on doing for other languages. Can we not expect the user to use the connection string directly? After providing the link from the previous point, it would make more sense to use the connection string directly instead of forming it using environment variables. Same comment for all the other code samples in the README

@yunhaoling
Copy link
Contributor Author

@ramya-rao-a thanks for the suggestions, I've updated readme as requested.
The python documentation link isn't vaild for now. It should be fixed today.

ramya-rao-a
ramya-rao-a approved these changes Jun 27, 2019
View reviewed changes
Copy link
Contributor

@ramya-rao-a ramya-rao-a left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great!

One last thing. Can we add a sample under "Create client" section after connection string, that shows how to create the client using the default azure credentials from Azure.Identity?

@yunhaoling yunhaoling requested a review from mayurid June 28, 2019 20:32
ramya-rao-a
ramya-rao-a reviewed Jun 28, 2019
View reviewed changes
sdk/eventhub/azure-eventhubs/HISTORY.md Outdated
- New error hierarchy
- `azure.error.EventHubError`
- `azure.error.ConnectionLostError`
- `azure.error.ConnectError`
- `azure.error.AuthenticationError`
- `azure.error.EventDataError`
- `azure.error.EventDataSendError`
- Renamed Sender/Receiver to EventHubProducer/EventHubConsumer
- Renamed Sender/Receiver to EventHubProducer/EventHubConsumer.
- New APIs for creating EventHubProducer/EventHubConsumer.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

New APIs create_producer/create_consumer on the EventHubClient to create EventHubProducer/EventHubConsumer

?

ramya-rao-a
ramya-rao-a reviewed Jun 28, 2019
View reviewed changes
Copy link
Contributor

@ramya-rao-a ramya-rao-a left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Missing breaking changes:

  • get_eventhub_info() got renamed
  • Event Position fromStart, fromEnd got renamed

Did we not have a counterpart to the new get_partition_properties before?

@yunhaoling
Copy link
Contributor Author

Just updated :)
We discussed with Johan and decided not to have fromStart, fromEnd method on EventPostition. These static helper functions are not pythonic. We don't have the from helper functions in Track1, so it's not a breaking change.

@yunhaoling yunhaoling merged commit 8e25821 into Azure:master Jun 29, 2019
annatisch added a commit that referenced this pull request Jul 2, 2019
@annatisch
[storage-file] Docs updates (#6189)
e9341e0 
* Fix failure to parse UTF8 files with BOM (#6160)

* Fix failure to parse UTF8 files with BOM

* Match frozen requirements in cosmos

* build universal wheels (#6173)

* Batch of doc

* Typo

* Update README and HISTORY of EventHub (#6151)

* Update readme

* Update sample code, obtain connection string and documentation reference in readme

* Remove import os in readme

* Added identity snippets in readme

* Update history, readme and license

* Update history

* Update history of EventHub

* Fix wrong version

* Update history of EventHub

* Update history to be more specific

* Update install command in readme for a preview version

* Update reference documentation link in readme

* don't scan anything under doc/ (#6185)

* Docs updates

* Some docs fixes

* Expand test coverage (#6170)

* Fixed model reference

* Fixed another reference

* Azure Storage Queue Track2 (#6039)

* Initial commit for Queues (#5656)

* Initial commit

* fix build

* fix build - 2

* add version

* API buildout (#5686)

* [Storage Queues] Add autorest layer to storage queues (#5687)

* add queue.json in swagger

* Add autorest layer

* Hooking up Queue client and Queue Service Client (#5817)

* Queue client

* changes

* shared access signature

* some fixes

* add tests

* Delete settings_real.py

* Refactored shared code and added tests

* Packaging update of azure-storage-queue

* Revert "Packaging update of azure-storage-queue"

This reverts commit fdc62ab.

* Add packaging overwrite

* Fixed setup

* Fixed dependency

* Storage Queues readme (#6073)

* queues readme [wip]

* small fixes

* docstrings for queues (#6066)

* Updated user-agent policy

* Updated token test

* Updated message iterator to pageable

* Renamed dequeue to receive

* Removed Py3.4 tag

* Clean pylint

* Code samples for queues (#6088)

* adds code samples for queues

* fixes to code samples and adds literalincludes for docs

* add links for TODO

* uses unicode strings for python2 compatibility

* fix readme link

* Fix CI

* [Storage Queue] pylint  + mypy pass (#6187)

* [storage-queue] Docs updates (#6186)

* Docs updates

* First round review feedback

* Adopt MSAL 0.4.1 (#6176)

* Azure Storage Blob Track2 (#5896)

* Storage blob track2 (#5894)

* Blob storage track 2

* Started pylint fixes

* Clean pylint

* Started blob walk

* Started docstrings

* Support walk blob

* Pylint

* Refactored upload

* Pylint

* Packaging update of azure-storage-blob

* Fixes to storage dependencies in CI (#5900)

* Revert "Packaging update of azure-storage-blob"

This reverts commit aeeb3ce.

* Fix Storage CI

* Fixed imports

* updating ccount_key_arg -> account_key_arg

* updating ordering

* Packaging update of azure-storage-blob

* Revert "Packaging update of azure-storage-blob"

This reverts commit 66d6877.

* reverting 66d6877. adding sdk_packaging.toml file

* docstrings for blobs (#5954)

* [storage-blob] Refactor shared code (#5960)

* Fix Storage CI

* Fixed imports

* Refactor shared storage code

* Fixed XML error

* Reverted change to models

* Merged models docstrings

* Fix setup.py version

* Missing recordings

* Fix storage SDK conflict

* Packaging update of azure-eventhubs

* Revert "Packaging update of azure-eventhubs"

This reverts commit df844f7.

* Fix EH packaging

* Updated shared code

* Review feedback

* [azure-storage-blob] Policy updates + simple upload/download (#6162)

* Last blob updates

* Azure core dependency version

* Update to user-agent policy

* Review feedback

* Removed old python tags

* Code samples for blobs (#6093)

* adds code samples for blobs

* fixes blob code samples and adds literalincludes for docs

* Storage Blobs Readme [wip] (#6011)

* blobs readme wip

* adding some samples and fixes for readme

* fix settings import

* moving code samples to a different PR

* small fixes to readme

* fill links for pypi and identity

* populating TODO links

* Fix CI

* [Storage Blob] pylint + mypy passs (#6175)

* pylint + mypy passs

* comments

* [storage-blob] Docs updates (#6184)

* Docs updates

* Some docstring fixes

* [storage-blob] Test rename (#6197)

* Test rename

* Removed test init files

* More renames

* Try flattening tests

* Blob test imports

* Flattened queue tests

* Renamed queue test case

* Updated manifest

* Renamed testcase

* Renamed samples

* Flattened tests

* Update PyPI package links on readme Key Vault (#6194)

* Renamed recordings

* fixes sample readme links (#6198)

* [azure-storage] Missing crypto dependency (#6203)

* [azure-storage] Missing crypto dependency

* Updated queue setup with crypto

* Fixed blob nspkg dependency

* Fixed queue nspkg dependency

* Added storage nspkg to shared deps

* Fixed dependencies

* Separate settings files
annatisch added a commit that referenced this pull request Jul 3, 2019
@annatisch
Azure Storage File Track2 (#6106)
1f02e1b 
* Files Skeleton (#5921)

* Generate storage files autorest layer (#5926)

* Generate autorest layer

* oops

* Rename files to file

* [Storage Files] API skeleton with helper files (#5965)

* Hookup File Service Client (#5977)

* Hookup share client (#6000)

* commit1

* Hook up Share Client

* Directory client hookup + File client  Hookup (#6040)

* file hookup

* changes

* [storage-files]Started adding files tests (#6051)

* Updated shared module

* Added tests

* First test pass

* Fixed client tests

* Fixed service props tests

* share tests (#6084)

* random commit

* share tests

* changes

* revert to fake settings

* Updates for file client tests

* Merged clients

* Fixed tests

* Recorded tests

* Clean test pass

* Packaging update of azure-storage-file

* Fixed acl test

* Fixed copy test

* More recordings

* Fixed copy recordings

* Fixed directory test

* Added close handles

* Updated packaging

* Updated user agent policy

* Updated dependencies

* Fixed handles tests

* Fixed syntax

* Files dependency conflict

* docstrings for files (#6128)

* Storage-File readme (#6156)

* adds file readme

* fix anchor for upload file

* Removed Py3.4 tag

* Clean pylint

* Fixed generated models

* Code samples for files (#6159)

* adds code samples for files

* fixes recording

* fixes code samples and adds literalincludes for docs

* fix links for readme

* Fix CI

* [storage-file] Docs updates (#6189)

* Fix failure to parse UTF8 files with BOM (#6160)

* Fix failure to parse UTF8 files with BOM

* Match frozen requirements in cosmos

* build universal wheels (#6173)

* Batch of doc

* Typo

* Update README and HISTORY of EventHub (#6151)

* Update readme

* Update sample code, obtain connection string and documentation reference in readme

* Remove import os in readme

* Added identity snippets in readme

* Update history, readme and license

* Update history

* Update history of EventHub

* Fix wrong version

* Update history of EventHub

* Update history to be more specific

* Update install command in readme for a preview version

* Update reference documentation link in readme

* don't scan anything under doc/ (#6185)

* Docs updates

* Some docs fixes

* Expand test coverage (#6170)

* Fixed model reference

* Fixed another reference

* Azure Storage Queue Track2 (#6039)

* Initial commit for Queues (#5656)

* Initial commit

* fix build

* fix build - 2

* add version

* API buildout (#5686)

* [Storage Queues] Add autorest layer to storage queues (#5687)

* add queue.json in swagger

* Add autorest layer

* Hooking up Queue client and Queue Service Client (#5817)

* Queue client

* changes

* shared access signature

* some fixes

* add tests

* Delete settings_real.py

* Refactored shared code and added tests

* Packaging update of azure-storage-queue

* Revert "Packaging update of azure-storage-queue"

This reverts commit fdc62ab.

* Add packaging overwrite

* Fixed setup

* Fixed dependency

* Storage Queues readme (#6073)

* queues readme [wip]

* small fixes

* docstrings for queues (#6066)

* Updated user-agent policy

* Updated token test

* Updated message iterator to pageable

* Renamed dequeue to receive

* Removed Py3.4 tag

* Clean pylint

* Code samples for queues (#6088)

* adds code samples for queues

* fixes to code samples and adds literalincludes for docs

* add links for TODO

* uses unicode strings for python2 compatibility

* fix readme link

* Fix CI

* [Storage Queue] pylint  + mypy pass (#6187)

* [storage-queue] Docs updates (#6186)

* Docs updates

* First round review feedback

* Adopt MSAL 0.4.1 (#6176)

* Azure Storage Blob Track2 (#5896)

* Storage blob track2 (#5894)

* Blob storage track 2

* Started pylint fixes

* Clean pylint

* Started blob walk

* Started docstrings

* Support walk blob

* Pylint

* Refactored upload

* Pylint

* Packaging update of azure-storage-blob

* Fixes to storage dependencies in CI (#5900)

* Revert "Packaging update of azure-storage-blob"

This reverts commit aeeb3ce.

* Fix Storage CI

* Fixed imports

* updating ccount_key_arg -> account_key_arg

* updating ordering

* Packaging update of azure-storage-blob

* Revert "Packaging update of azure-storage-blob"

This reverts commit 66d6877.

* reverting 66d6877. adding sdk_packaging.toml file

* docstrings for blobs (#5954)

* [storage-blob] Refactor shared code (#5960)

* Fix Storage CI

* Fixed imports

* Refactor shared storage code

* Fixed XML error

* Reverted change to models

* Merged models docstrings

* Fix setup.py version

* Missing recordings

* Fix storage SDK conflict

* Packaging update of azure-eventhubs

* Revert "Packaging update of azure-eventhubs"

This reverts commit df844f7.

* Fix EH packaging

* Updated shared code

* Review feedback

* [azure-storage-blob] Policy updates + simple upload/download (#6162)

* Last blob updates

* Azure core dependency version

* Update to user-agent policy

* Review feedback

* Removed old python tags

* Code samples for blobs (#6093)

* adds code samples for blobs

* fixes blob code samples and adds literalincludes for docs

* Storage Blobs Readme [wip] (#6011)

* blobs readme wip

* adding some samples and fixes for readme

* fix settings import

* moving code samples to a different PR

* small fixes to readme

* fill links for pypi and identity

* populating TODO links

* Fix CI

* [Storage Blob] pylint + mypy passs (#6175)

* pylint + mypy passs

* comments

* [storage-blob] Docs updates (#6184)

* Docs updates

* Some docstring fixes

* [storage-blob] Test rename (#6197)

* Test rename

* Removed test init files

* More renames

* Try flattening tests

* Blob test imports

* Flattened queue tests

* Renamed queue test case

* Updated manifest

* Renamed testcase

* Renamed samples

* Flattened tests

* Update PyPI package links on readme Key Vault (#6194)

* Renamed recordings

* fixes sample readme links (#6198)

* [azure-storage] Missing crypto dependency (#6203)

* [azure-storage] Missing crypto dependency

* Updated queue setup with crypto

* Fixed blob nspkg dependency

* Fixed queue nspkg dependency

* Added storage nspkg to shared deps

* Fixed dependencies

* Separate settings files

* [Storage File] pylint + mypy pass (#6202)
rajivnandivada pushed a commit to rajivnandivada/azure-sdk-for-python that referenced this pull request Jul 3, 2019
@yunhaoling @rajivnandivada
Update README and HISTORY of EventHub (Azure#6151)
02086a1 
* Update readme

* Update sample code, obtain connection string and documentation reference in readme

* Remove import os in readme

* Added identity snippets in readme

* Update history, readme and license

* Update history

* Update history of EventHub

* Fix wrong version

* Update history of EventHub

* Update history to be more specific

* Update install command in readme for a preview version

* Update reference documentation link in readme
rajivnandivada pushed a commit to rajivnandivada/azure-sdk-for-python that referenced this pull request Jul 3, 2019
@annatisch @rajivnandivada
Azure Storage File Track2 (Azure#6106)
5b709c7 
* Files Skeleton (Azure#5921)

* Generate storage files autorest layer (Azure#5926)

* Generate autorest layer

* oops

* Rename files to file

* [Storage Files] API skeleton with helper files (Azure#5965)

* Hookup File Service Client (Azure#5977)

* Hookup share client (Azure#6000)

* commit1

* Hook up Share Client

* Directory client hookup + File client  Hookup (Azure#6040)

* file hookup

* changes

* [storage-files]Started adding files tests (Azure#6051)

* Updated shared module

* Added tests

* First test pass

* Fixed client tests

* Fixed service props tests

* share tests (Azure#6084)

* random commit

* share tests

* changes

* revert to fake settings

* Updates for file client tests

* Merged clients

* Fixed tests

* Recorded tests

* Clean test pass

* Packaging update of azure-storage-file

* Fixed acl test

* Fixed copy test

* More recordings

* Fixed copy recordings

* Fixed directory test

* Added close handles

* Updated packaging

* Updated user agent policy

* Updated dependencies

* Fixed handles tests

* Fixed syntax

* Files dependency conflict

* docstrings for files (Azure#6128)

* Storage-File readme (Azure#6156)

* adds file readme

* fix anchor for upload file

* Removed Py3.4 tag

* Clean pylint

* Fixed generated models

* Code samples for files (Azure#6159)

* adds code samples for files

* fixes recording

* fixes code samples and adds literalincludes for docs

* fix links for readme

* Fix CI

* [storage-file] Docs updates (Azure#6189)

* Fix failure to parse UTF8 files with BOM (Azure#6160)

* Fix failure to parse UTF8 files with BOM

* Match frozen requirements in cosmos

* build universal wheels (Azure#6173)

* Batch of doc

* Typo

* Update README and HISTORY of EventHub (Azure#6151)

* Update readme

* Update sample code, obtain connection string and documentation reference in readme

* Remove import os in readme

* Added identity snippets in readme

* Update history, readme and license

* Update history

* Update history of EventHub

* Fix wrong version

* Update history of EventHub

* Update history to be more specific

* Update install command in readme for a preview version

* Update reference documentation link in readme

* don't scan anything under doc/ (Azure#6185)

* Docs updates

* Some docs fixes

* Expand test coverage (Azure#6170)

* Fixed model reference

* Fixed another reference

* Azure Storage Queue Track2 (Azure#6039)

* Initial commit for Queues (Azure#5656)

* Initial commit

* fix build

* fix build - 2

* add version

* API buildout (Azure#5686)

* [Storage Queues] Add autorest layer to storage queues (Azure#5687)

* add queue.json in swagger

* Add autorest layer

* Hooking up Queue client and Queue Service Client (Azure#5817)

* Queue client

* changes

* shared access signature

* some fixes

* add tests

* Delete settings_real.py

* Refactored shared code and added tests

* Packaging update of azure-storage-queue

* Revert "Packaging update of azure-storage-queue"

This reverts commit fdc62ab.

* Add packaging overwrite

* Fixed setup

* Fixed dependency

* Storage Queues readme (Azure#6073)

* queues readme [wip]

* small fixes

* docstrings for queues (Azure#6066)

* Updated user-agent policy

* Updated token test

* Updated message iterator to pageable

* Renamed dequeue to receive

* Removed Py3.4 tag

* Clean pylint

* Code samples for queues (Azure#6088)

* adds code samples for queues

* fixes to code samples and adds literalincludes for docs

* add links for TODO

* uses unicode strings for python2 compatibility

* fix readme link

* Fix CI

* [Storage Queue] pylint  + mypy pass (Azure#6187)

* [storage-queue] Docs updates (Azure#6186)

* Docs updates

* First round review feedback

* Adopt MSAL 0.4.1 (Azure#6176)

* Azure Storage Blob Track2 (Azure#5896)

* Storage blob track2 (Azure#5894)

* Blob storage track 2

* Started pylint fixes

* Clean pylint

* Started blob walk

* Started docstrings

* Support walk blob

* Pylint

* Refactored upload

* Pylint

* Packaging update of azure-storage-blob

* Fixes to storage dependencies in CI (Azure#5900)

* Revert "Packaging update of azure-storage-blob"

This reverts commit aeeb3ce.

* Fix Storage CI

* Fixed imports

* updating ccount_key_arg -> account_key_arg

* updating ordering

* Packaging update of azure-storage-blob

* Revert "Packaging update of azure-storage-blob"

This reverts commit 66d6877.

* reverting 66d6877. adding sdk_packaging.toml file

* docstrings for blobs (Azure#5954)

* [storage-blob] Refactor shared code (Azure#5960)

* Fix Storage CI

* Fixed imports

* Refactor shared storage code

* Fixed XML error

* Reverted change to models

* Merged models docstrings

* Fix setup.py version

* Missing recordings

* Fix storage SDK conflict

* Packaging update of azure-eventhubs

* Revert "Packaging update of azure-eventhubs"

This reverts commit df844f7.

* Fix EH packaging

* Updated shared code

* Review feedback

* [azure-storage-blob] Policy updates + simple upload/download (Azure#6162)

* Last blob updates

* Azure core dependency version

* Update to user-agent policy

* Review feedback

* Removed old python tags

* Code samples for blobs (Azure#6093)

* adds code samples for blobs

* fixes blob code samples and adds literalincludes for docs

* Storage Blobs Readme [wip] (Azure#6011)

* blobs readme wip

* adding some samples and fixes for readme

* fix settings import

* moving code samples to a different PR

* small fixes to readme

* fill links for pypi and identity

* populating TODO links

* Fix CI

* [Storage Blob] pylint + mypy passs (Azure#6175)

* pylint + mypy passs

* comments

* [storage-blob] Docs updates (Azure#6184)

* Docs updates

* Some docstring fixes

* [storage-blob] Test rename (Azure#6197)

* Test rename

* Removed test init files

* More renames

* Try flattening tests

* Blob test imports

* Flattened queue tests

* Renamed queue test case

* Updated manifest

* Renamed testcase

* Renamed samples

* Flattened tests

* Update PyPI package links on readme Key Vault (Azure#6194)

* Renamed recordings

* fixes sample readme links (Azure#6198)

* [azure-storage] Missing crypto dependency (Azure#6203)

* [azure-storage] Missing crypto dependency

* Updated queue setup with crypto

* Fixed blob nspkg dependency

* Fixed queue nspkg dependency

* Added storage nspkg to shared deps

* Fixed dependencies

* Separate settings files

* [Storage File] pylint + mypy pass (Azure#6202)
@yunhaoling yunhaoling deleted the eventhub-patch branch August 6, 2019 23:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ramya-rao-a ramya-rao-a ramya-rao-a approved these changes

@mayurid mayurid Awaiting requested review from mayurid

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@yunhaoling @adxsdk6 @ramya-rao-a