You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -40,7 +40,7 @@ Libraries which enable you to provision specific resources. They are responsible
40
40
## Need help?
41
41
42
42
* For detailed documentation visit our [Azure SDK for Python documentation](https://aka.ms/python-docs)
43
-
* File an issue via [Github Issues](../../issues)
43
+
* File an issue via [Github Issues](https://github.com/Azure/azure-sdk-for-python/issues)
44
44
* Check [previous questions](https://stackoverflow.com/questions/tagged/azure+python) or ask new ones on StackOverflow using `azure` and `python` tags.
Copy file name to clipboardExpand all lines: doc/dev/mgmt/generation.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,7 +8,7 @@ IMPORTANT NOTE: All the commands prefixed by `python` in this page assumes you h
8
8
9
9
### Autorest versioning
10
10
11
-
A few notes on [Autorest for Python versionning](https://github.com/Azure/autorest.python/blob/master/ChangeLog.md):
11
+
A few notes on [Autorest for Python versioning](https://github.com/Azure/autorest.python/blob/master/ChangeLog.md):
12
12
- Autorest for Python v2.x is deprecated, and should not be used anymore for any generation under any circumstances.
13
13
- Autorest for Python v3.x is the most currently used one. Should not be used, but still ok if service team are still in v3.x and they want to avoid breaking changes for a given version (rare).
14
14
- Autorest for Python v4.x is the current recommendation. This generator can generates async code, but this should be disabled with --no-async. No package should be shipped with async based on v4
Copy file name to clipboardExpand all lines: doc/dev/mgmt/swagger/multi_api/readme.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,7 +8,7 @@ This is the AutoRest configuration file for Network.
8
8
9
9
## Getting Started
10
10
11
-
To build the SDK for Network, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run:
11
+
To build the SDK for Network, simply [Install AutoRest](https://github.com/Azure/autorest/blob/master/docs/installing-autorest.md) and in this folder, run:
12
12
13
13
> `autorest`
14
14
@@ -66,4 +66,4 @@ swagger-to-sdk:
66
66
67
67
## Python
68
68
69
-
See configuration in [readme.python.md](./readme.python.md)
69
+
See configuration in [readme.python.md](https://github.com/Azure/azure-sdk-for-python/blob/master/doc/dev/mgmt/swagger/multi_api/readme.python.md)
Copy file name to clipboardExpand all lines: doc/dev/mgmt/swagger/single_api/readme.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,7 +8,7 @@ This is the AutoRest configuration file for Cdn.
8
8
9
9
---
10
10
## Getting Started
11
-
To build the SDK for Cdn, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run:
11
+
To build the SDK for Cdn, simply [Install AutoRest](https://github.com/Azure/autorest/blob/master/docs/installing-autorest.md) and in this folder, run:
Copy file name to clipboardExpand all lines: doc/dev/mgmt/swagger_conf.md
+11-11Lines changed: 11 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,42 +14,42 @@ In practical terms, we want to control the version of Autorest used, the output
14
14
15
15
## Writing the readme
16
16
17
-
Writing the readme is the responsability of the Python SDK team. There is currently two types of templates for Python readmes:
17
+
Writing the readme is the responsibility of the Python SDK team. There is currently two types of templates for Python readmes:
18
18
- Readme that handles only one API version, and generates packages that handle one API version only
19
19
- Readme that handles several API versions, and generates packages with multiples API and profile supports
20
20
21
-
These templates can be found in the [single_api](./single_api) and the [multi_api](./multi_api) folders.
21
+
These templates can be found in the [single_api](https://github.com/Azure/azure-sdk-for-python/blob/master/doc/dev/mgmt/swagger/single_api) and the [multi_api](https://github.com/Azure/azure-sdk-for-python/blob/master/doc/dev/mgmt/swagger/multi_api) folders.
22
22
23
23
24
24
### Single API readmes
25
25
26
26
This one is the most simple:
27
-
- Copy the [readme.python.md](./single_api/readme.python.md) and replace `servicetoreplace` by your service name
28
-
- Be sure the main [readme.md](./single_api/readme.md) contains a "swagger-to-sdk" section with Python
27
+
- Copy the [readme.python.md](https://github.com/Azure/azure-sdk-for-python/blob/master/doc/dev/mgmt/swagger/single_api/readme.python.md) and replace `servicetoreplace` by your service name
28
+
- Be sure the main [readme.md](https://github.com/Azure/azure-sdk-for-python/blob/master/doc/dev/mgmt/swagger/single_api/readme.md) contains a "swagger-to-sdk" section with Python
29
29
30
30
### Multi API readmes
31
31
32
-
When doing multi-api packages, it means you have shipping several "tags" of the main readme as one package. Autorest is calling this process a "batch" call, and this is the purpose of the "batch" section in [readme.python.md](./multi_api/readme.python.md).
32
+
When doing multi-api packages, it means you have shipping several "tags" of the main readme as one package. Autorest is calling this process a "batch" call, and this is the purpose of the "batch" section in [readme.python.md](https://github.com/Azure/azure-sdk-for-python/blob/master/doc/dev/mgmt/swagger/multi_api/readme.python.md).
33
33
34
34
In order to be sure the correct tags exist, you can use the following script:
This script will analyze the Swaggers available, and suggests on stdout:
40
-
- A list of tags for the main [readme.md](./multi_api/readme.md)
41
-
- A batch declaration for the [readme.python.md](./multi_api/readme.python.md)
40
+
- A list of tags for the main [readme.md](https://github.com/Azure/azure-sdk-for-python/blob/master/doc/dev/mgmt/swagger/multi_api/readme.md)
41
+
- A batch declaration for the [readme.python.md](https://github.com/Azure/azure-sdk-for-python/blob/master/doc/dev/mgmt/swagger/multi_api/readme.python.md)
42
42
43
43
This script is not perfect that it *does* require manual review of the output and not a direct copy/paste.
44
44
45
45
It's important for Python that tags represents only *ONE* unique API version. It's why it's pretty common that Python uses a set of tags that other languages don't use.
46
46
47
47
Once you know the list of tags you need to generate:
48
48
49
-
- Copy the [readme.python.md](./multi_api/readme.python.md) and replace `servicetoreplace` by your service name
50
-
- Update the batch list of [readme.python.md](./multi_api/readme.python.md)
51
-
- Be sure you have one tag section for each batch entry in [readme.python.md](./multi_api/readme.python.md)
52
-
- Be sure the main [readme.md](./multi_api/readme.md) contains a "swagger-to-sdk" section with Python with an `afterscripts` section like the one in the template.
49
+
- Copy the [readme.python.md](https://github.com/Azure/azure-sdk-for-python/blob/master/doc/dev/mgmt/swagger/multi_api/readme.python.md) and replace `servicetoreplace` by your service name
50
+
- Update the batch list of [readme.python.md](https://github.com/Azure/azure-sdk-for-python/blob/master/doc/dev/mgmt/swagger/multi_api/readme.python.md)
51
+
- Be sure you have one tag section for each batch entry in [readme.python.md](https://github.com/Azure/azure-sdk-for-python/blob/master/doc/dev/mgmt/swagger/multi_api/readme.python.md)
52
+
- Be sure the main [readme.md](https://github.com/Azure/azure-sdk-for-python/blob/master/doc/dev/mgmt/swagger/multi_api/readme.md) contains a "swagger-to-sdk" section with Python with an `afterscripts` section like the one in the template.
53
53
54
54
The `afterscripts` will execute a Jinja template to create a client to link together all the batch generated autorest ([example](https://github.com/Azure/azure-sdk-for-python/blob/4a7c67189591b052fe2b5769847ff68f7845386d/sdk/storage/azure-mgmt-storage/azure/mgmt/storage/_storage_management_client.py))
0 commit comments