|
1 | 1 | # Generating with Autorest for Python |
2 | 2 |
|
3 | | -See [here](https://github.com/Azure/autorest.python/wiki/Generating-with-autorest-for-python-v5.0.0) for Python-specific docs, and [here] for general docs |
4 | | - |
5 | | -# Contributing |
6 | | - |
7 | | -This project welcomes contributions and suggestions. Most contributions require you to agree to a |
8 | | -Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us |
9 | | -the rights to use your contribution. For details, visit https://cla.microsoft.com. |
10 | | - |
11 | | -When you submit a pull request, a CLA-bot will automatically determine whether you need to provide |
12 | | -a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions |
13 | | -provided by the bot. You will only need to do this once across all repos using our CLA. |
14 | | - |
15 | | -This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). |
16 | | -For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or |
17 | | -contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments. |
18 | | - |
19 | | -### Autorest plugin configuration |
20 | | - |
21 | | -- Please don't edit this section unless you're re-configuring how the powershell extension plugs in to AutoRest |
22 | | - AutoRest needs the below config to pick this up as a plug-in - see https://github.com/Azure/autorest/blob/master/docs/developer/architecture/AutoRest-extension.md |
| 3 | +**This emitter is deprecated and will no longer receive support** |
23 | 4 |
|
24 | 5 | #### Python code gen |
25 | 6 |
|
@@ -138,33 +119,6 @@ scope-multiclientscript/emitter: |
138 | 119 | output-artifact: python-files |
139 | 120 | ``` |
140 | 121 |
|
141 | | -# Help |
142 | | -
|
143 | | -```yaml |
144 | | -help-content: |
145 | | - python: # type: Help as defined in autorest-core/help.ts |
146 | | - activationScope: python |
147 | | - categoryFriendlyName: Python Generator |
148 | | - settings: |
149 | | - - key: python-sdks-folder |
150 | | - description: The path to the root directory of your azure-sdk-for-python clone. Be sure to note that we include `sdk` in the folder path. |
151 | | - - key: black |
152 | | - description: Runs black formatting on your generated files. Defaults to `false`. |
153 | | - type: string |
154 | | - - key: basic-setup-py |
155 | | - description: Whether to generate a build script for setuptools to package your SDK. Defaults to `false`, generally not suggested if you are going to wrap the generated code |
156 | | - type: bool |
157 | | - - key: no-namespace-folders |
158 | | - description: Specify if you don't want pkgutil-style namespace folders. Defaults to `false`. |
159 | | - type: bool |
160 | | - - key: credential-default-policy-type |
161 | | - description: Specify the default credential policy (authentication policy) for your client. Use in conjunction with `--add-credential`. Currently only supports `BearerTokenCredentialPolicy`, `ARMChallengeAuthenticationPolicy` and `AzureKeyCredentialPolicy`. Default value is `BearerTokenCredentialPolicy`(data-plan)/`ARMChallengeAuthenticationPolicy`(mgmt-plan). `--credential-scopes` is tied with `BearerTokenCredentialPolicy` and `ARMChallengeAuthenticationPolicy`, do not pass them in if you want `AzureKeyCredentialPolicy`. |
162 | | - type: string |
163 | | - - key: credential-key-header-name |
164 | | - description: The name of the header which will pass the credential. Use if you have `--credential-default-policy-type` set to `AzureKeyCredentialPolicy`. For example, if generating cognitive services code, you might use `--credential-key-header-name=Ocp-Apim-Subscription-Key` |
165 | | - type: string |
166 | | -``` |
167 | | -
|
168 | 122 | <!-- LINKS --> |
169 | 123 |
|
170 | 124 | [python_docs]: https://github.com/Azure/autorest.python/tree/main/docs/readme.md |
|
0 commit comments