Skip to content
This repository was archived by the owner on May 22, 2026. It is now read-only.

Commit 28a5851

Browse files
authored
update readmes (#3498)
1 parent 3bca3b1 commit 28a5851

3 files changed

Lines changed: 3 additions & 244 deletions

File tree

README.md

Lines changed: 1 addition & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -1,62 +1,3 @@
11
# Python Generator Packages
22

3-
## Requirements
4-
5-
- Node 20+
6-
- pnpm 9+
7-
- Python 3.9+
8-
9-
## Develop
10-
11-
This project uses [pnpm workspaces](https://pnpm.io/workspaces) to manage multiple packages.
12-
13-
```bash
14-
pnpm install
15-
```
16-
17-
2. Build
18-
19-
```bash
20-
pnpm build
21-
```
22-
23-
3. Build TS in watch mode
24-
25-
```bash
26-
pnpm watch
27-
```
28-
29-
4. Clean
30-
31-
```bash
32-
pnpm clean
33-
```
34-
35-
## Release a new version
36-
37-
**Semi-auto:**
38-
39-
Follow https://github.com/Azure/autorest.python/blob/main/.github/skills/bump-and-release/SKILL.md to make a release PR.
40-
After it merged, [release pipeline](https://dev.azure.com/azure-sdk/internal/_build?definitionId=1668) will be triggered automatically to release new version.
41-
42-
## Contributing
43-
44-
This project welcomes contributions and suggestions. Most contributions require you to agree to a
45-
Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us
46-
the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.
47-
48-
When you submit a pull request, a CLA bot will automatically determine whether you need to provide
49-
a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions
50-
provided by the bot. You will only need to do this once across all repos using our CLA.
51-
52-
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
53-
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
54-
contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
55-
56-
## Trademarks
57-
58-
This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft
59-
trademarks or logos is subject to and must follow
60-
[Microsoft's Trademark & Brand Guidelines](https://www.microsoft.com/en-us/legal/intellectualproperty/trademarks/usage/general).
61-
Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship.
62-
Any use of third-party trademarks or logos are subject to those third-party's policies.
3+
**This repo is deprecated, the unbranded emitter `@azure-tools/typespec-python` has moved [here](https://github.com/Azure/typespec-azure/tree/main/packages/typespec-python) and the `autorest.python` emitter is no longer supported**

packages/autorest.python/README.md

Lines changed: 1 addition & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,6 @@
11
# Generating with Autorest for Python
22

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**
234

245
#### Python code gen
256

@@ -138,33 +119,6 @@ scope-multiclientscript/emitter:
138119
output-artifact: python-files
139120
```
140121
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-
168122
<!-- LINKS -->
169123
170124
[python_docs]: https://github.com/Azure/autorest.python/tree/main/docs/readme.md

packages/typespec-python/README.md

Lines changed: 1 addition & 137 deletions
Original file line numberDiff line numberDiff line change
@@ -1,139 +1,3 @@
11
# @azure-tools/typespec-python
22

3-
TypeSpec emitter for Python SDKs
4-
5-
## Install
6-
7-
```bash
8-
npm install @azure-tools/typespec-python
9-
```
10-
11-
## Usage
12-
13-
1. Via the command line
14-
15-
```bash
16-
tsp compile . --emit=@azure-tools/typespec-python
17-
```
18-
19-
2. Via the config
20-
21-
```yaml
22-
emit:
23-
- "@azure-tools/typespec-python"
24-
```
25-
26-
The config can be extended with options as follows:
27-
28-
```yaml
29-
emit:
30-
- "@azure-tools/typespec-python"
31-
options:
32-
"@azure-tools/typespec-python":
33-
option: value
34-
```
35-
36-
## Emitter options
37-
38-
### `emitter-output-dir`
39-
40-
**Type:** `absolutePath`
41-
42-
Defines the emitter output directory. Defaults to `{output-dir}/@azure-tools/typespec-python`
43-
See [Configuring output directory for more info](https://typespec.io/docs/handbook/configuration/configuration/#configuring-output-directory)
44-
45-
### `examples-dir`
46-
47-
**Type:** `string`
48-
49-
Specifies the directory where the emitter will look for example files. If the flag isn’t set, the emitter defaults to using an `examples` directory located at the project root.
50-
51-
### `namespace`
52-
53-
**Type:** `string`
54-
55-
Specifies the namespace you want to override for namespaces set in the spec. With this config, all namespace for the spec types will default to it.
56-
57-
### `flavor`
58-
59-
**Type:** `string`
60-
61-
The flavor of the SDK.
62-
63-
### `models-mode`
64-
65-
**Type:** `"dpg" | "none"`
66-
67-
What kind of models to generate. If you pass in `none`, we won't generate models. `dpg` models are the default models we generate.
68-
69-
### `generate-sample`
70-
71-
**Type:** `boolean`
72-
73-
Whether to generate sample files, for basic samples of your generated sdks. Defaults to `false`.
74-
75-
### `generate-test`
76-
77-
**Type:** `boolean`
78-
79-
Whether to generate test files, for basic testing of your generated sdks. Defaults to `false`.
80-
81-
### `api-version`
82-
83-
**Type:** `string`
84-
85-
Use this flag if you would like to generate the sdk only for a specific version. Default value is the latest version. Also accepts values `latest` and `all`.
86-
87-
### `license`
88-
89-
**Type:** `object`
90-
91-
License information for the generated client code.
92-
93-
### `package-version`
94-
95-
**Type:** `string`
96-
97-
The version of the package.
98-
99-
### `package-name`
100-
101-
**Type:** `string`
102-
103-
The name of the package.
104-
105-
### `generate-packaging-files`
106-
107-
**Type:** `boolean`
108-
109-
Whether to generate packaging files. Packaging files refer to the `setup.py`, `README`, and other files that are needed to package your code.
110-
111-
### `packaging-files-dir`
112-
113-
**Type:** `string`
114-
115-
If you are using a custom packaging files directory, you can specify it here. We won't generate with the default packaging files we have.
116-
117-
### `packaging-files-config`
118-
119-
**Type:** `object`
120-
121-
If you are using a custom packaging files directory, and have additional configuration parameters you want to pass in during generation, you can specify it here. Only applicable if `packaging-files-dir` is set.
122-
123-
### `package-pprint-name`
124-
125-
**Type:** `string`
126-
127-
The name of the package to be used in pretty-printing. Will be the name of the package in `README` and pprinting of `setup.py`.
128-
129-
### `head-as-boolean`
130-
131-
**Type:** `boolean`
132-
133-
Whether to return responses from HEAD requests as boolean. Defaults to `true`.
134-
135-
### `use-pyodide`
136-
137-
**Type:** `boolean`
138-
139-
Whether to generate using `pyodide` instead of `python`. If there is no python installed on your device, we will default to using pyodide to generate the code.
3+
**This emitter has moved to [this](https://github.com/Azure/typespec-azure/tree/main/packages/typespec-python) repo.**

0 commit comments

Comments
 (0)