Skip to content

Commit

Permalink
Merge pull request #3 from Azure/main
Browse files Browse the repository at this point in the history
Update 7/1
  • Loading branch information
BigCat20196 authored Jul 1, 2021
2 parents 89cb1ee + a8c9c6c commit ceb1300
Show file tree
Hide file tree
Showing 1,914 changed files with 54,499 additions and 32,919 deletions.
4 changes: 2 additions & 2 deletions .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Instructions for CODEOWNERS file format and automatic build failure notifications:
# https://github.com/Azure/azure-sdk/blob/master/docs/policies/opensource.md#codeowners
# https://github.com/Azure/azure-sdk/blob/main/docs/policies/opensource.md#codeowners

###########
# SDK
Expand Down Expand Up @@ -131,7 +131,7 @@
/common/smoketest/ @lmazuel @chlowell @annatisch @rakshith91 @shurd @southpolesteve

# Management Plane
/**/*mgmt*/ @RAY-316 @msyyc
/**/*mgmt*/ @RAY-316 @msyyc


###########
Expand Down
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,9 @@ build/
TestResults/
ENV_DIR/

# Perf test profiling
cProfile-*.pstats

# tox generated artifacts
test-junit-*.xml
pylint-*.out.txt
Expand Down
16 changes: 8 additions & 8 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ follow the instructions provided in [Microsoft Azure Projects Contribution Guide

## Building and Testing

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.
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.

[A Brief Overview of Tox](https://tox.readthedocs.io/en/latest/)

Expand All @@ -20,11 +20,11 @@ Instead, the CI system leverages an tox plugin called `tox-monorepo`. This plugi
A given `tox.ini` works on the concept of `test environments`. A given test environment is a combination of:

1. An identifier (or identifiers)
2. A targeted Python version
2. A targeted Python version
1. `tox` will default to base python executing the `tox` command if no Python environment is specified
3. (optionally) an OS platform

Internally `tox` leverages `virtualenv` to create each test environment's virtual environment.
Internally `tox` leverages `virtualenv` to create each test environment's virtual environment.

This means that once the `tox` workflow is in place, all tests will be executed _within a virtual environment._

Expand All @@ -41,7 +41,7 @@ sdist

Unfortunately, the command `tox -l` only returns the _default_ test builds. The common `tox.ini` file also supports `lint` and `mypy` environments.

### Example Usage of the common Azure SDK For Python `tox.ini`
### Example Usage of the common Azure SDK For Python `tox.ini`

Basic usage of `tox` within this monorepo is:

Expand All @@ -51,7 +51,7 @@ Basic usage of `tox` within this monorepo is:

The common `tox.ini` location is `eng/tox/tox.ini` within the repository.

If at any time you want to blow away the tox created virtual environments and start over, simply append `-r` to any tox invocation!
If at any time you want to blow away the tox created virtual environments and start over, simply append `-r` to any tox invocation!

#### Example `azure-core` mypy

Expand Down Expand Up @@ -113,11 +113,11 @@ Mypy install and run.

### Performance Testing

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).
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).

### More Reading

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.
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.

### Dev Feed
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.
Expand Down Expand Up @@ -146,5 +146,5 @@ This tox test( devtest) will fail if installed dependent packages are not dev bu

## Code of Conduct
This project's code of conduct can be found in the
[CODE_OF_CONDUCT.md file](https://github.com/Azure/azure-sdk-for-python/blob/master/CODE_OF_CONDUCT.md)
[CODE_OF_CONDUCT.md file](https://github.com/Azure/azure-sdk-for-python/blob/main/CODE_OF_CONDUCT.md)
(v1.4.0 of the https://contributor-covenant.org/ CoC).
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Azure SDK for Python

[![Packages](https://img.shields.io/badge/packages-latest-blue.svg)](https://azure.github.io/azure-sdk/releases/latest/python.html) [![Dependencies](https://img.shields.io/badge/dependency-report-blue.svg)](https://azuresdkartifacts.blob.core.windows.net/azure-sdk-for-python/dependencies/dependencies.html) [![DepGraph](https://img.shields.io/badge/dependency-graph-blue.svg)](https://azuresdkartifacts.blob.core.windows.net/azure-sdk-for-python/dependencies/InterdependencyGraph.html) [![Python](https://img.shields.io/pypi/pyversions/azure-core.svg?maxAge=2592000)](https://pypi.python.org/pypi/azure/) [![Build Status](https://dev.azure.com/azure-sdk/public/_apis/build/status/python/python%20-%20core%20-%20ci?branchName=master)](https://dev.azure.com/azure-sdk/public/_build/latest?definitionId=458&branchName=master)
[![Packages](https://img.shields.io/badge/packages-latest-blue.svg)](https://azure.github.io/azure-sdk/releases/latest/python.html) [![Dependencies](https://img.shields.io/badge/dependency-report-blue.svg)](https://azuresdkartifacts.blob.core.windows.net/azure-sdk-for-python/dependencies/dependencies.html) [![DepGraph](https://img.shields.io/badge/dependency-graph-blue.svg)](https://azuresdkartifacts.blob.core.windows.net/azure-sdk-for-python/dependencies/InterdependencyGraph.html) [![Python](https://img.shields.io/pypi/pyversions/azure-core.svg?maxAge=2592000)](https://pypi.python.org/pypi/azure/) [![Build Status](https://dev.azure.com/azure-sdk/public/_apis/build/status/python/python%20-%20core%20-%20ci?branchName=main)](https://dev.azure.com/azure-sdk/public/_build/latest?definitionId=458&branchName=main)

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).

Expand All @@ -24,7 +24,7 @@ Each service might have a number of libraries available from each of the followi

### Client: New Releases

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).
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).

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)

Expand All @@ -36,7 +36,7 @@ Last stable versions of packages that have been provided for usage with Azure an

### Management: New Releases
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.
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).
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).

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)

Expand All @@ -62,7 +62,7 @@ Security issues and bugs should be reported privately, via email, to the Microso

## Contributing

For details on contributing to this repository, see the [contributing guide](https://github.com/Azure/azure-sdk-for-python/blob/master/CONTRIBUTING.md).
For details on contributing to this repository, see the [contributing guide](https://github.com/Azure/azure-sdk-for-python/blob/main/CONTRIBUTING.md).

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.
Expand Down
2 changes: 0 additions & 2 deletions ci_template.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@
trigger:
branches:
include:
- master
- main
- hotfix/*
- release/*
Expand All @@ -16,7 +15,6 @@ trigger:
pr:
branches:
include:
- master
- main
- feature/*
- hotfix/*
Expand Down
4 changes: 2 additions & 2 deletions common/smoketest/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ If a python version below 3.5 is being used, it is still possible to run the sam
## Key concepts

## Examples
All the classes in this sample has a `Run()` method as entry point, and do not depend on each other.
All the classes in this sample has a `Run()` method as entry point, and do not depend on each other.

It is possible to run them individually:
```python
Expand Down Expand Up @@ -124,7 +124,7 @@ Be sure to set the environment variables and credentials required before running
The libraries in the `requiriments_async.txt` are not installed and the python version used has async capabilities. Install the libraries using pip.

## Next steps
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.
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.

## Contributing
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.
Expand Down
6 changes: 3 additions & 3 deletions doc/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
This folder contains some documentations for this repository:

The folder structure is the following
- [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/
- [dev](https://github.com/Azure/azure-sdk-for-python/blob/master/doc/dev) : contains advanced documentation for _developers_ of SDK (not _consumers_ of SDK)
- [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/
- [dev](https://github.com/Azure/azure-sdk-for-python/blob/main/doc/dev) : contains advanced documentation for _developers_ of SDK (not _consumers_ of SDK)

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.
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.
9 changes: 5 additions & 4 deletions doc/dev/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,9 @@
This folder contains documentation for developers of SDK: internal teams at Microsoft, or advanced contributors.

Overview of the documents:
- [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
- [release](https://github.com/Azure/azure-sdk-for-python/blob/master/doc/dev/release.md) : How to release a package when ready
- [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`
- [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
- [release](https://github.com/Azure/azure-sdk-for-python/blob/main/doc/dev/release.md) : How to release a package when ready
- [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`
- [engsys.md](https://github.com/Azure/azure-sdk-for-python/blob/main/doc/eng_sys_checks.md): Options for PR validation checks, how to opt-in, and how to run them locally

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`)
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`)
10 changes: 5 additions & 5 deletions doc/dev/mgmt/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,13 @@

The documentation in that folder is intended for developers at Microsoft, or for advanced contributors, in the ARM (Azure Resource Management) world.

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.
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.

In order of workflow:
- [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
- [tests.md](https://github.com/Azure/azure-sdk-for-python/blob/master/doc/dev/mgmt/tests.md) : How to test management SDK (recordings, etc.)
- [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.
- [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
- [tests.md](https://github.com/Azure/azure-sdk-for-python/blob/main/doc/dev/mgmt/tests.md) : How to test management SDK (recordings, etc.)
- [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.

More implementations / advanced documents:
- [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
- [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

4 changes: 2 additions & 2 deletions doc/dev/mgmt/cheatsheet.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

Following Dockerfile can be used to build entire environment:

https://github.com/Azure/azure-sdk-for-python/blob/master/tools/Dockerfile
https://github.com/Azure/azure-sdk-for-python/blob/main/tools/Dockerfile

## Create a venv

Expand Down Expand Up @@ -66,7 +66,7 @@ Available options:

## ChangeLog

Changelog is generated by performing following steps:
Changelog is generated by performing following steps:
- generate code report for last version on PyPI:
- generate code report for version installed in current venv
- generate a markdown changelog
Expand Down
6 changes: 3 additions & 3 deletions doc/dev/mgmt/generation.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Generation of SDK

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.
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.

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.
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.

## Building the code

Expand Down Expand Up @@ -39,7 +39,7 @@ In practical terms, this is not necessary since the Python SDK has the necessary
- Checkout the RestAPI specs repo
- 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.

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)
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)

### Automation bot

Expand Down
2 changes: 1 addition & 1 deletion doc/dev/mgmt/mgmt_release.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Once Swagger PR is merged, SDK automation will create pull request to Azure SDK

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.

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.
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.

## Manual generation

Expand Down
Loading

0 comments on commit ceb1300

Please sign in to comment.