[Template][Docs] Update template files (Azure#30305)

pvaneck · web-flow · commit 3d4176c15898 · 2023-05-11T11:14:34.000-07:00
These are updated to more accurately reflect the current state of
things.

Signed-off-by: Paul Van Eck &lt;paulvaneck@microsoft.com&gt;
diff --git a/doc/dev/packaging.md b/doc/dev/packaging.md
@@ -1,5 +1,7 @@
 # Azure packaging
 
+[comment]: # ( cspell:ignore myservice )
+
 This article describes the recommendations for defining namespace packaging to release a package inside the `azure` namespace. Being inside the `azure` namespace means that a service `myservice` can be imported using:
 ```python
 import azure.myservice
@@ -115,6 +117,7 @@ setup(
         'Programming Language :: Python :: 3.8',
         'Programming Language :: Python :: 3.9',
         'Programming Language :: Python :: 3.10',
+        'Programming Language :: Python :: 3.11',
         'License :: OSI Approved :: MIT License',
     ],
     python_requires=">=3.7",
@@ -144,7 +147,7 @@ Since the package is Python 3 only, do NOT make this wheel universal. This usual
 
 # I already have a package that supports Python 2, can I get short version on how to udpate to Python 3 only?
 
-- Remove "universal" from setup.cfg, or completly remove the file if it was the only option
+- Remove "universal" from setup.cfg, or completely remove the file if it was the only option
 - In setup.py:
   - Remove `extra_requires`
   - Add `python_requires=">=3.7",`
@@ -184,4 +187,4 @@ The "extras_requires" section MUST include a conditional dependency on "azure-ns
     }
 ```
 
-An additional verification is that wheels installs `azure-nskpg` ONLY on Python 2.
+An additional verification is that wheels installs `azure-nspkg` ONLY on Python 2.
diff --git a/sdk/template/azure-template/CHANGELOG.md b/sdk/template/azure-template/CHANGELOG.md
@@ -1,22 +1,63 @@
 # Release History
 
+[comment]: # (Change log guidance: https://azure.github.io/azure-sdk/policies_releases.html#changelog-guidance)
+
+## 0.0.18 (Unreleased)
+
+### Features Added
+
+- Some feature
+
+### Breaking Changes
+
+- Some breaking change
+
+### Bugs Fixed
+
+- Some bug fix
+
+### Other Changes
+
+- Some other change
+
 ## 0.0.18b2 (2020-09-04)
+
+### Bugs Fixed
+
 - Testing release tag version
 
 ## 0.0.13b1 (2020-08-27)
+
+### Bugs Fixed
+
 - Testing out some alpha and beta versioning
 
 ## 0.0.7 (2020-07-02)
+
+### Bugs Fixed
+
 - Test a successful Release
 
 ## 0.0.6 (2020-05-20)
+
+### Bugs Fixed
+
 - Test a successful Release
 
 ## 0.0.5 (2020-05-20)
+
+### Bugs Fixed
+
 - Test a successful Release
 
 ## 0.0.2 (2020-03-24)
+
+### Bugs Fixed
+
 - Test Release Pipeline
 
 ## 0.0.1 (2019-10-06)
-  - Template package
+
+### Features Added
+
+- Template package
diff --git a/sdk/template/azure-template/README.md b/sdk/template/azure-template/README.md
@@ -1,12 +1,12 @@
-[![Build Status](https://dev.azure.com/azure-sdk/public/_apis/build/status/azure-sdk-for-python.client?branchName=master)](https://dev.azure.com/azure-sdk/public/_build/latest?definitionId=46?branchName=master)
+[![Build Status](https://dev.azure.com/azure-sdk/public/_apis/build/status/472?branchName=main)](https://dev.azure.com/azure-sdk/public/_build/latest?definitionId=472)
 
 # Azure Template Package client library for Python
 
-This template package matches necessary patterns that the development team has established to create a unified sdk functional from Python 2.7 onwards. The packages contained herein can be installed singly or as part of the `azure` namespace. Any other introductory text should go here.
+This template package matches necessary patterns that the development team has established to create a unified SDK. The packages contained herein can be installed singly or as part of the `azure` namespace. Any other introductory text should go here.
 
-This package has been tested with Python 2.7, 3.5, 3.6, 3.7 and 3.8
+This package has been tested with Python 3.7+.
 
-For a more complete set of Azure libraries, see https://aka.ms/azsdk/python/all
+For a more complete set of Azure libraries, see https://aka.ms/azsdk/python/all.
 
 # Getting started
 
diff --git a/sdk/template/azure-template/azure/template/__init__.py b/sdk/template/azure-template/azure/template/__init__.py
@@ -1,3 +1,8 @@
+# -------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for
+# license information.
+# --------------------------------------------------------------------------
 from ._version import VERSION
 from .template_code import template_main
 
diff --git a/sdk/template/azure-template/azure/template/_version.py b/sdk/template/azure-template/azure/template/_version.py
@@ -1,2 +1,8 @@
+# -------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for
+# license information.
+# --------------------------------------------------------------------------
+
 # matches SEMVER
 VERSION = "0.0.18b3"
diff --git a/sdk/template/azure-template/azure/template/template_code.py b/sdk/template/azure-template/azure/template/template_code.py
@@ -1,3 +1,10 @@
-def template_main():
+# -------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for
+# license information.
+# --------------------------------------------------------------------------
+
+
+def template_main() -> bool:
     print("Package code.")
-    return True
+    return True
diff --git a/sdk/template/azure-template/pyproject.toml b/sdk/template/azure-template/pyproject.toml
@@ -1,3 +1,7 @@
 [tool.azure-sdk-build]
-pylint=false
-verifytypes = false
+mypy = true
+type_check_samples = true
+verifytypes = true
+pyright = true
+pylint = true
+black = true
diff --git a/sdk/template/azure-template/samples/README.md b/sdk/template/azure-template/samples/README.md
@@ -0,0 +1,47 @@
+---
+page_type: sample
+languages:
+    - python
+products:
+    - azure
+    - azure-template
+urlFragment: azure-template-samples
+---
+
+# Azure Template samples
+
+Provide an overview of all the samples and explain how to run them.
+
+For guidance on the samples README, visit the [sample guide](https://github.com/Azure/azure-sdk-for-python/blob/main/doc/dev/sample_guide.md#package-sample-readme).
+
+
+|**File Name**|**Description**|
+|----------------|-------------|
+|[sample_simple.py][sample_simple] | Run template sample method |
+
+## Prerequisites
+
+* Python 3.7 or later is required to use this package.
+
+## Setup
+
+1. Install the Azure Template client library for Python with [pip][pip]:
+
+    ```sh
+    pip install azure-template
+    ```
+
+2. Clone or download the repository containing this sample code. Alternatively, you can download the sample file directly.
+
+## Running the samples
+
+ Navigate to the directory that the sample(s) are saved in, and follow the usage described in the file. For example, `python sample_simple.py`.
+
+## Next steps
+
+Link the API reference docs for your package in this section.
+
+<!-- Links -->
+
+[sample_simple]: https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/template/azure-template/samples/sample_simple.py
+[pip]: https://pypi.org/project/pip/
diff --git a/sdk/template/azure-template/samples/sample_simple.py b/sdk/template/azure-template/samples/sample_simple.py
@@ -1,10 +1,26 @@
+# -------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for
+# license information.
+# -------------------------------------------------------------------------
+
 """
-See https://github.com/Azure/azure-sdk-for-python/blob/main/doc/dev/sample_guide.md
+FILE: sample_simple.py
+
+DESCRIPTION:
+    This sample demonstrates how to run the template method from the template package. Here, you should
+    explain what the sample does and what setup is necessary to run it.
+
+    See https://github.com/Azure/azure-sdk-for-python/blob/main/doc/dev/sample_guide.md for more details.
+
+USAGE:
+    python sample_simple.py
 """
 
 from azure.template import template_main
 
-def simple_sample():
+
+def simple_sample() -> None:
     print("Running simple sample")
     template_main()
     print("Completed running simple sample")
diff --git a/sdk/template/azure-template/setup.py b/sdk/template/azure-template/setup.py
@@ -1,3 +1,11 @@
+#!/usr/bin/env python
+
+# -------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for
+# license information.
+# --------------------------------------------------------------------------
+
 from setuptools import setup, find_packages
 import os
 from io import open
@@ -8,7 +16,7 @@
 # your package.
 
 # this setup.py is set up in a specific way to keep the azure* and azure-mgmt-* namespaces WORKING all the way
-# up from python 2.7. Reference here: https://github.com/Azure/azure-sdk-for-python/wiki/Azure-packaging
+# up from python 2.7. Reference here: https://github.com/Azure/azure-sdk-for-python/blob/main/doc/dev/packaging.md
 
 PACKAGE_NAME = "azure-template"
 PACKAGE_PPRINT_NAME = "Template Package"
@@ -49,6 +57,7 @@
         "Programming Language :: Python :: 3.8",
         "Programming Language :: Python :: 3.9",
         "Programming Language :: Python :: 3.10",
+        "Programming Language :: Python :: 3.11",
         "License :: OSI Approved :: MIT License",
     ],
     packages=find_packages(
@@ -63,7 +72,7 @@
     ),
     include_package_data=True,
     package_data={
-        'azure.template': ['py.typed'],
+        "azure.template": ["py.typed"],
     },
     install_requires=[
         "azure-core<2.0.0,>=1.10.0",
diff --git a/sdk/template/azure-template/tests/test_simple.py b/sdk/template/azure-template/tests/test_simple.py
@@ -10,7 +10,6 @@
 # `AzureRecordedTestCase` provides methods for client creation, resource naming, and more.
 # Tools from `devtools_testutils` are not required; plain `pytest` unit tests can be sufficient in some scenarios.
 class TestDataPlane(AzureRecordedTestCase):
-
     def setup_method(self, method):
         # Code in this optional method will be executed before each test in the class runs.
         # Fixtures can also perform test-specific setup: https://docs.pytest.org/latest/explanation/fixtures.html
@@ -24,7 +23,6 @@ def test_case_default(self):
 # This class should only be used by management-plane libraries in most cases. `azure-mgmt-*` libraries have their own
 # reference material for testing: https://github.com/Azure/azure-sdk-for-python/blob/main/doc/dev/mgmt/tests.md.
 class TestMgmtPlane(AzureMgmtRecordedTestCase):
-
     def setup_method(self, method):
         pass
 
