Skip to content

Commit 7afd7c9

Browse files
authored
[AVA] Updating links in package ReadMe (#18800)
* added lva sdk package * deleteing folder * updating links in Readme * updating links
1 parent 18f4f5c commit 7afd7c9

File tree

6 files changed

+15
-18
lines changed

6 files changed

+15
-18
lines changed
Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
# Release History
22

3-
---
4-
5-
## 1.0.0b1 (2021-01-13)
3+
## 1.0.0b1 (2021-05-19)
64

75
Initial release

sdk/videoanalyzer/azure-media-videoanalyzer-edge/README.md

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -22,13 +22,13 @@ pip install azure-media-videoanalyzer-edge
2222
### Prerequisites
2323

2424
- Python 2.7, or 3.6 or later is required to use this package.
25-
- You need an active [Azure subscription][azure_sub], and a [IoT device connection string][iot_device_connection_string] to use this package.
25+
- You need an active [Azure subscription][azure_sub], and a IoT device connection string to use this package.
2626
- To interact with Azure IoT Hub you will need to run `pip install azure-iot-hub`
2727
- You will need to use the version of the SDK that corresponds to the version of the Video Analyzer Edge module you are using.
2828

2929
| SDK | Video Analyzer Edge Module |
3030
|---|---|
31-
| 1.0.0b1 | 2.0 |
31+
| 1.0.0b1 | 1.0 |
3232

3333
### Creating a pipline topology and making requests
3434

@@ -56,8 +56,8 @@ To create a pipeline topology you need to define parameters, sources, and sinks.
5656

5757
```python
5858
#Parameters
59-
user_name_param = ParameterDeclaration(name="rtspUserName",type="String",default="dummyusername")
60-
password_param = ParameterDeclaration(name="rtspPassword",type="SecretString",default="dummypassword")
59+
user_name_param = ParameterDeclaration(name="rtspUserName",type="String",default="testusername")
60+
password_param = ParameterDeclaration(name="rtspPassword",type="SecretString",default="testpassword")
6161
url_param = ParameterDeclaration(name="rtspUrl",type="String",default="rtsp://www.sample.com")
6262
hub_param = ParameterDeclaration(name="hubSinkOutputName",type="String")
6363

@@ -140,16 +140,15 @@ additional questions or comments.
140140
[coc_faq]: https://opensource.microsoft.com/codeofconduct/faq/
141141
[coc_contact]: mailto:[email protected]
142142

143-
[package]: TODO://link-to-published-package
143+
[package]: https://aka.ms/ava/sdk/client/python
144144
[source]: https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/videoanalyzer
145145
[samples]: https://github.com/Azure-Samples/live-video-analytics-iot-edge-python
146146

147-
[doc_direct_methods]: TODO://link
148-
[doc_pipelines]: TODO://link
149-
[doc_product]: TODO://link
147+
[doc_direct_methods]: https://go.microsoft.com/fwlink/?linkid=2162396
148+
[doc_pipelines]: https://go.microsoft.com/fwlink/?linkid=2162396
149+
[doc_product]: https://go.microsoft.com/fwlink/?linkid=2162396
150150

151151
[iot-device-sdk]: https://pypi.org/project/azure-iot-device/
152152
[iot-hub-sdk]: https://pypi.org/project/azure-iot-hub/
153-
[iot_device_connection_string]: TODO://link
154153

155154
[github-page-issues]: https://github.com/Azure/azure-sdk-for-python/issues

sdk/videoanalyzer/azure-media-videoanalyzer-edge/azure/media/videoanalyzeredge/_version.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,4 @@
44
# Licensed under the MIT License. See License.txt in the project root for license information.
55
# --------------------------------------------------------------------------
66

7-
VERSION = '1.0.0b1'
7+
VERSION = "1.0.0b1"

sdk/videoanalyzer/azure-media-videoanalyzer-edge/docs/DevTips.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ A quick description of the five commands above:
3434

3535
### Troubleshooting tox errors
3636

37-
- Tox will complain if there are no tests. Add a dummy test in case you need to bypass this
37+
- Tox will complain if there are no tests. Add an empty test in case you need to bypass this
3838
- Make sure there is an `__init__.py` file inside of every directory inside of `azure` (Example: `azure/media` should have an __init__.py file)
3939
- Follow the ReadMe guidelines outlined here: https://review.docs.microsoft.com/help/contribute-ref/contribute-ref-how-to-document-sdk?branch=master#readme. ReadMe titles are case SENSITIVE and use sentence casing.
4040
- Make sure MANIFEST.in includes all required folders. (Most likely the required folders will be tests, samples, and the generated folder)

sdk/videoanalyzer/azure-media-videoanalyzer-edge/samples/sample_lva.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,8 @@
1616
def build_pipeline_topology():
1717
pipeline_topology_properties = PipelineTopologyProperties()
1818
pipeline_topology_properties.description = "Continuous video recording to an Azure Media Services Asset"
19-
user_name_param = ParameterDeclaration(name="rtspUserName",type="String",default="dummyusername")
20-
password_param = ParameterDeclaration(name="rtspPassword",type="SecretString",default="dummypassword")
19+
user_name_param = ParameterDeclaration(name="rtspUserName",type="String",default="testusername")
20+
password_param = ParameterDeclaration(name="rtspPassword",type="SecretString",default="testpassword")
2121
url_param = ParameterDeclaration(name="rtspUrl",type="String",default="rtsp://www.sample.com")
2222
hub_param = ParameterDeclaration(name="hubSinkOutputName",type="String")
2323

sdk/videoanalyzer/azure-media-videoanalyzer-edge/tests/test_build_graph_serialize.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@ def test_build_pipeline_serialize(self):
66
pipeline_topology_properties = PipelineTopologyProperties()
77
pipeline_topology_name = 'pipelineTopologyTest'
88
pipeline_topology_properties.description = "Continuous video recording to an Azure Media Services Asset"
9-
user_name_param = ParameterDeclaration(name="rtspUserName",type="String",default="dummyusername")
10-
password_param = ParameterDeclaration(name="rtspPassword",type="SecretString",default="dummypassword")
9+
user_name_param = ParameterDeclaration(name="rtspUserName",type="String",default="testusername")
10+
password_param = ParameterDeclaration(name="rtspPassword",type="SecretString",default="testpassword")
1111
url_param = ParameterDeclaration(name="rtspUrl",type="String",default="rtsp://www.sample.com")
1212
hub_param = ParameterDeclaration(name="hubSinkOutputName",type="String")
1313

0 commit comments

Comments
 (0)