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: CONTRIBUTING.md
+8-8
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,7 @@ follow the instructions provided in [Microsoft Azure Projects Contribution Guide
5
5
6
6
## Building and Testing
7
7
8
-
The Azure SDK team's Python CI leverages the tool `tox` to distribute tests to virtual environments, handle test dependency installation, and coordinate tooling reporting during PR/CI builds. This means that a dev working locally can reproduce _exactly_ what the build machine is doing.
8
+
The Azure SDK team's Python CI leverages the tool `tox` to distribute tests to virtual environments, handle test dependency installation, and coordinate tooling reporting during PR/CI builds. This means that a dev working locally can reproduce _exactly_ what the build machine is doing.
9
9
10
10
[A Brief Overview of Tox](https://tox.readthedocs.io/en/latest/)
11
11
@@ -20,11 +20,11 @@ Instead, the CI system leverages an tox plugin called `tox-monorepo`. This plugi
20
20
A given `tox.ini` works on the concept of `test environments`. A given test environment is a combination of:
21
21
22
22
1. An identifier (or identifiers)
23
-
2. A targeted Python version
23
+
2. A targeted Python version
24
24
1.`tox` will default to base python executing the `tox` command if no Python environment is specified
25
25
3. (optionally) an OS platform
26
26
27
-
Internally `tox` leverages `virtualenv` to create each test environment's virtual environment.
27
+
Internally `tox` leverages `virtualenv` to create each test environment's virtual environment.
28
28
29
29
This means that once the `tox` workflow is in place, all tests will be executed _within a virtual environment._
30
30
@@ -41,7 +41,7 @@ sdist
41
41
42
42
Unfortunately, the command `tox -l` only returns the _default_ test builds. The common `tox.ini` file also supports `lint` and `mypy` environments.
43
43
44
-
### Example Usage of the common Azure SDK For Python `tox.ini`
44
+
### Example Usage of the common Azure SDK For Python `tox.ini`
45
45
46
46
Basic usage of `tox` within this monorepo is:
47
47
@@ -51,7 +51,7 @@ Basic usage of `tox` within this monorepo is:
51
51
52
52
The common `tox.ini` location is `eng/tox/tox.ini` within the repository.
53
53
54
-
If at any time you want to blow away the tox created virtual environments and start over, simply append `-r` to any tox invocation!
54
+
If at any time you want to blow away the tox created virtual environments and start over, simply append `-r` to any tox invocation!
55
55
56
56
#### Example `azure-core` mypy
57
57
@@ -113,11 +113,11 @@ Mypy install and run.
113
113
114
114
### Performance Testing
115
115
116
-
SDK performance testing is supported via the custom `perfstress` framework. For full details on this framework, and how to write and run tests for an SDK - see the [perfstress tests documentation](https://github.com/Azure/azure-sdk-for-python/blob/master/doc/dev/perfstress_tests.md).
116
+
SDK performance testing is supported via the custom `perfstress` framework. For full details on this framework, and how to write and run tests for an SDK - see the [perfstress tests documentation](https://github.com/Azure/azure-sdk-for-python/blob/main/doc/dev/perfstress_tests.md).
117
117
118
118
### More Reading
119
119
120
-
We maintain an [additional document](https://github.com/Azure/azure-sdk-for-python/blob/master/doc/eng_sys_checks.md) that has a ton of detail as to what is actually _happening_ in these executions.
120
+
We maintain an [additional document](https://github.com/Azure/azure-sdk-for-python/blob/main/doc/eng_sys_checks.md) that has a ton of detail as to what is actually _happening_ in these executions.
121
121
122
122
### Dev Feed
123
123
Daily dev build version of Azure sdk packages for python are available and are uploaded to Azure devops feed daily. We have also created a tox environment to test a package against dev built version of dependent packages. Below is the link to Azure devops feed.
@@ -146,5 +146,5 @@ This tox test( devtest) will fail if installed dependent packages are not dev bu
146
146
147
147
## Code of Conduct
148
148
This project's code of conduct can be found in the
This repository is for active development of the Azure SDK for Python. For consumers of the SDK we recommend visiting our [public developer docs](https://docs.microsoft.com/python/azure/) or our versioned [developer docs](https://azure.github.io/azure-sdk-for-python).
6
6
@@ -24,7 +24,7 @@ Each service might have a number of libraries available from each of the followi
24
24
25
25
### Client: New Releases
26
26
27
-
New wave of packages that we are announcing as **GA** and several that are currently releasing in **preview**. These libraries allow you to use and consume existing resources and interact with them, for example: upload a blob. These libraries share a number of core functionalities such as: retries, logging, transport protocols, authentication protocols, etc. that can be found in the [azure-core](https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/core/azure-core) library. You can learn more about these libraries by reading guidelines that they follow [here](https://azure.github.io/azure-sdk/python/guidelines/index.html).
27
+
New wave of packages that we are announcing as **GA** and several that are currently releasing in **preview**. These libraries allow you to use and consume existing resources and interact with them, for example: upload a blob. These libraries share a number of core functionalities such as: retries, logging, transport protocols, authentication protocols, etc. that can be found in the [azure-core](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/core/azure-core) library. You can learn more about these libraries by reading guidelines that they follow [here](https://azure.github.io/azure-sdk/python/guidelines/index.html).
28
28
29
29
You can find the [most up to date list of all of the new packages on our page](https://azure.github.io/azure-sdk/releases/latest/index.html#python-packages)
30
30
@@ -36,7 +36,7 @@ Last stable versions of packages that have been provided for usage with Azure an
36
36
37
37
### Management: New Releases
38
38
A new set of management libraries that follow the [Azure SDK Design Guidelines for Python](https://azure.github.io/azure-sdk/python/guidelines/) are now available. These new libraries provide a number of core capabilities that are shared amongst all Azure SDKs, including the intuitive Azure Identity library, an HTTP Pipeline with custom policies, error-handling, distributed tracing, and much more.
39
-
Documentation and code samples for these new libraries can be found [here](https://aka.ms/azsdk/python/mgmt). In addition, a migration guide that shows how to transition from older versions of libraries is located [here](https://github.com/Azure/azure-sdk-for-python/blob/master/doc/sphinx/mgmt_quickstart.rst#migration-guide).
39
+
Documentation and code samples for these new libraries can be found [here](https://aka.ms/azsdk/python/mgmt). In addition, a migration guide that shows how to transition from older versions of libraries is located [here](https://github.com/Azure/azure-sdk-for-python/blob/main/doc/sphinx/mgmt_quickstart.rst#migration-guide).
40
40
41
41
You can find the [most up to date list of all of the new packages on our page](https://azure.github.io/azure-sdk/releases/latest/mgmt/python.html)
42
42
@@ -62,7 +62,7 @@ Security issues and bugs should be reported privately, via email, to the Microso
62
62
63
63
## Contributing
64
64
65
-
For details on contributing to this repository, see the [contributing guide](https://github.com/Azure/azure-sdk-for-python/blob/master/CONTRIBUTING.md).
65
+
For details on contributing to this repository, see the [contributing guide](https://github.com/Azure/azure-sdk-for-python/blob/main/CONTRIBUTING.md).
66
66
67
67
This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit
Copy file name to clipboardExpand all lines: common/smoketest/README.md
+2-2
Original file line number
Diff line number
Diff line change
@@ -79,7 +79,7 @@ If a python version below 3.5 is being used, it is still possible to run the sam
79
79
## Key concepts
80
80
81
81
## Examples
82
-
All the classes in this sample has a `Run()` method as entry point, and do not depend on each other.
82
+
All the classes in this sample has a `Run()` method as entry point, and do not depend on each other.
83
83
84
84
It is possible to run them individually:
85
85
```python
@@ -124,7 +124,7 @@ Be sure to set the environment variables and credentials required before running
124
124
The libraries in the `requiriments_async.txt` are not installed and the python version used has async capabilities. Install the libraries using pip.
125
125
126
126
## Next steps
127
-
Check the [Azure SDK for Python Repository](https://github.com/Azure/azure-sdk-for-python/tree/master/sdk) for more samples inside the sdk folder.
127
+
Check the [Azure SDK for Python Repository](https://github.com/Azure/azure-sdk-for-python/tree/main/sdk) for more samples inside the sdk folder.
128
128
129
129
## Contributing
130
130
This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.
This folder contains some documentations for this repository:
2
2
3
3
The folder structure is the following
4
-
-[sphinx](https://github.com/Azure/azure-sdk-for-python/blob/master/doc/sphinx) : contains the documentation source code for https://azure.github.io/azure-sdk-for-python/
5
-
-[dev](https://github.com/Azure/azure-sdk-for-python/blob/master/doc/dev) : contains advanced documentation for _developers_ of SDK (not _consumers_ of SDK)
4
+
-[sphinx](https://github.com/Azure/azure-sdk-for-python/blob/main/doc/sphinx) : contains the documentation source code for https://azure.github.io/azure-sdk-for-python/
5
+
-[dev](https://github.com/Azure/azure-sdk-for-python/blob/main/doc/dev) : contains advanced documentation for _developers_ of SDK (not _consumers_ of SDK)
6
6
7
-
The file [eng_sys_checks](https://github.com/Azure/azure-sdk-for-python/blob/master/doc/eng_sys_checks.md) is a read up as to what a standard `ci.yml` will actually execute.
7
+
The file [eng_sys_checks](https://github.com/Azure/azure-sdk-for-python/blob/main/doc/eng_sys_checks.md) is a read up as to what a standard `ci.yml` will actually execute.
Copy file name to clipboardExpand all lines: doc/dev/README.md
+4-4
Original file line number
Diff line number
Diff line change
@@ -3,8 +3,8 @@
3
3
This folder contains documentation for developers of SDK: internal teams at Microsoft, or advanced contributors.
4
4
5
5
Overview of the documents:
6
-
-[dev setup](https://github.com/Azure/azure-sdk-for-python/blob/master/doc/dev/dev_setup.md) : How to create a development environment for this repo
7
-
-[release](https://github.com/Azure/azure-sdk-for-python/blob/master/doc/dev/release.md) : How to release a package when ready
8
-
-[packaging.md](https://github.com/Azure/azure-sdk-for-python/blob/master/doc/dev/packaging.md) : How to organize packaging information for packages under `azure`
6
+
-[dev setup](https://github.com/Azure/azure-sdk-for-python/blob/main/doc/dev/dev_setup.md) : How to create a development environment for this repo
7
+
-[release](https://github.com/Azure/azure-sdk-for-python/blob/main/doc/dev/release.md) : How to release a package when ready
8
+
-[packaging.md](https://github.com/Azure/azure-sdk-for-python/blob/main/doc/dev/packaging.md) : How to organize packaging information for packages under `azure`
9
9
10
-
The [mgmt](https://github.com/Azure/azure-sdk-for-python/blob/master/doc/dev/mgmt) folder contains information specific to management packages (i.e. packages prefixed by `azure-mgmt`)
10
+
The [mgmt](https://github.com/Azure/azure-sdk-for-python/blob/main/doc/dev/mgmt) folder contains information specific to management packages (i.e. packages prefixed by `azure-mgmt`)
Copy file name to clipboardExpand all lines: doc/dev/mgmt/README.md
+5-5
Original file line number
Diff line number
Diff line change
@@ -2,13 +2,13 @@
2
2
3
3
The documentation in that folder is intended for developers at Microsoft, or for advanced contributors, in the ARM (Azure Resource Management) world.
4
4
5
-
The [cheat sheet](https://github.com/Azure/azure-sdk-for-python/blob/master/doc/dev/mgmt/cheatsheet.md) page contains a quick reminder of the basic commands if you are already familiar with this repo.
5
+
The [cheat sheet](https://github.com/Azure/azure-sdk-for-python/blob/main/doc/dev/mgmt/cheatsheet.md) page contains a quick reminder of the basic commands if you are already familiar with this repo.
6
6
7
7
In order of workflow:
8
-
-[swagger_conf.md](https://github.com/Azure/azure-sdk-for-python/blob/master/doc/dev/mgmt/swagger_conf.md) : Describe how to configure the different Readme on https://github.com/Azure/azure-rest-api-specs for Python
9
-
-[tests.md](https://github.com/Azure/azure-sdk-for-python/blob/master/doc/dev/mgmt/tests.md) : How to test management SDK (recordings, etc.)
10
-
-[mgmt_release.md](https://github.com/Azure/azure-sdk-for-python/blob/master/doc/dev/mgmt/mgmt_release.md) : How to finish preapring the package, changelog, version, etc.
8
+
-[swagger_conf.md](https://github.com/Azure/azure-sdk-for-python/blob/main/doc/dev/mgmt/swagger_conf.md) : Describe how to configure the different Readme on https://github.com/Azure/azure-rest-api-specs for Python
9
+
-[tests.md](https://github.com/Azure/azure-sdk-for-python/blob/main/doc/dev/mgmt/tests.md) : How to test management SDK (recordings, etc.)
10
+
-[mgmt_release.md](https://github.com/Azure/azure-sdk-for-python/blob/main/doc/dev/mgmt/mgmt_release.md) : How to finish preapring the package, changelog, version, etc.
11
11
12
12
More implementations / advanced documents:
13
-
-[changelog_impl.md](https://github.com/Azure/azure-sdk-for-python/blob/master/doc/dev/mgmt/changelog_impl.md) : Technical details about the change log tool implementation
13
+
-[changelog_impl.md](https://github.com/Azure/azure-sdk-for-python/blob/main/doc/dev/mgmt/changelog_impl.md) : Technical details about the change log tool implementation
Copy file name to clipboardExpand all lines: doc/dev/mgmt/generation.md
+3-3
Original file line number
Diff line number
Diff line change
@@ -1,8 +1,8 @@
1
1
# Generation of SDK
2
2
3
-
Assuming your Swagger are associated with correct Readmes (otherwise see previous chapter [Swagger conf](https://github.com/Azure/azure-sdk-for-python/blob/master/doc/dev/mgmt/swagger_conf.md)), this page explains how to generate your packages.
3
+
Assuming your Swagger are associated with correct Readmes (otherwise see previous chapter [Swagger conf](https://github.com/Azure/azure-sdk-for-python/blob/main/doc/dev/mgmt/swagger_conf.md)), this page explains how to generate your packages.
4
4
5
-
IMPORTANT NOTE: All the commands prefixed by `python` in this page assumes you have loaded the [dev_setup](https://github.com/Azure/azure-sdk-for-python/blob/master/doc/dev/dev_setup.md) in your currently loaded virtual environment.
5
+
IMPORTANT NOTE: All the commands prefixed by `python` in this page assumes you have loaded the [dev_setup](https://github.com/Azure/azure-sdk-for-python/blob/main/doc/dev/dev_setup.md) in your currently loaded virtual environment.
6
6
7
7
## Building the code
8
8
@@ -39,7 +39,7 @@ In practical terms, this is not necessary since the Python SDK has the necessary
39
39
- Checkout the RestAPI specs repo
40
40
- Call the tool: `python -m packaging_tools.generate_sdk -v -m restapi_path/readme.md` changing the last path to the readme you want to generate.
41
41
42
-
The common configuration to pass to all generation are located in the [swagger_to_sdk.json file](https://github.com/Azure/azure-sdk-for-python/blob/master/swagger_to_sdk_config.json)
42
+
The common configuration to pass to all generation are located in the [swagger_to_sdk.json file](https://github.com/Azure/azure-sdk-for-python/blob/main/swagger_to_sdk_config.json)
Copy file name to clipboardExpand all lines: doc/dev/mgmt/mgmt_release.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -16,7 +16,7 @@ Once Swagger PR is merged, SDK automation will create pull request to Azure SDK
16
16
17
17
Once you have a PR that contains accurate with correct tests (or no tests at all, but CI is green), this page explains how to prepare for a release.
18
18
19
-
IMPORTANT NOTE: All the commands in this page assumes you have loaded the [dev_setup](https://github.com/Azure/azure-sdk-for-python/blob/master/doc/dev/dev_setup.md) in your currently loaded virtual environment.
19
+
IMPORTANT NOTE: All the commands in this page assumes you have loaded the [dev_setup](https://github.com/Azure/azure-sdk-for-python/blob/main/doc/dev/dev_setup.md) in your currently loaded virtual environment.
0 commit comments