1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
|
# Mgmt helper commands cheat sheet
## Dockerized environment
Following Dockerfile can be used to build entire environment:
https://github.com/Azure/azure-sdk-for-python/blob/main/tools/Dockerfile
## Create a venv
Windows:<br/>
`py -3.7 -m venv env3.7`
Linux (or Windows with Python from app store):<br/>
`python3 -m venv env3.7`
## Setup a venv for development
For all packages:<br/>
`python ./scripts/dev_setup.py`
For a specific package:<br/>
```shell
export PACKAGE=azure-mgmt-servicename
python ./scripts/dev_setup.py -p $PACKAGE
```
## Generate tags for multi-api Swagger Readme
`python ./scripts/multi_api_readme_help.py /azure-rest-api-specs/specification/service/resource-manager/`
## Generate a package
```shell
python -m packaging_tools.generate_sdk -v -m restapi_path/readme.md
```
Regenerate multi-api client:<br/>
`python ./scripts/multiapi_init_gen.py azure-mgmt-myservice`
Regenerate multi-api of multi-client package:<br/>
`python ./scripts/multiapi_init_gen.py azure-mgmt-myservice#subclientname`
## Update packaging setup.py / MANIFEST / etc.
Locally:<br/>
`python -m packaging_tools --build-conf azure-mgmt-myservice`
Update a given PR (needs GH_TOKEN env variable set):<br/>
`python -m packaging_tools.update_pr -v -p 3979`
Edit `sdk_packaging.toml` if necesseray and restart the tool.
Available options:
| option name | type | description | example |
| --- | --- | --- | --- |
| auto_update | bool | If false, disable the bot system | false |
| package_name | str | package name | azure-mgmt-myservice |
| package_nspkg | str | namespace package name | azure-mgmt-nspkg |
| package_pprint_name | str | The nice name to show on PyPI | MyService Management |
| package_doc_id | str | the moniker on docs.microsoft.com (could be empty) | my-service |
| is_stable | bool | Should have discriminer as stable | false |
| is_arm | bool | needs a dependency on msrestazure | true |
## ChangeLog
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
```shell
python -m packaging_tools.code_report --last-pypi $PACKAGE --output=$HOME/old.json
python -m packaging_tools.code_report $PACKAGE --output=$HOME/new.json
python -m packaging_tools.change_log $HOME/old.json $HOME/new.json
```
## Tests
Env variable quick copy/paste for Powershell:
```powershell
$env:AZURE_TEST_RUN_LIVE='true'
$env:AZURE_TEST_RUN_LIVE='false'
Remove-Item Env:\AZURE_TEST_RUN_LIVE
```
Env variable quick copy/paste for Linux:
```shell
export AZURE_TEST_RUN_LIVE=true
export AZURE_TEST_RUN_LIVE=false
unset AZURE_TEST_RUN_LIVE
```
Start all tests:<br/>`pytest`
Start test for a package:<br/>`pytest -s sdk/service/azure-mgmt-service`
Start a specific test for a package:<br/>`pytest -s sdk/service/azure-mgmt-service -k TestFeatureOne`
## pip
Install a package from Github with pip, from a subfolder:<br/>
`pip install "git+https://github.com/Azure/azure-sdk-for-python#subdirectory=sdk/service/azure-mgmt-service&egg=azure-mgmt-service"`
Install a package from Github with pip, from a subfolder and a special branch:<br/>
`pip install "git+https://github.com/Azure/azure-sdk-for-python@mybranch#subdirectory=sdk/service/azure-mgmt-service&egg=azure-mgmt-service"`
|
