The azdev
tool is designed to aid new and experienced developers in contributing to Azure CLI command modules and extensions.
3. Basics with azdev style/test/linter
4. Creating modules with azdev cli create
5. Create extensions with azdev extension create
6. Publishing extensions with azdev extension publish
-
Install Python 3.6+ from http://python.org. Please note that the version of Python that comes preinstalled on OSX is 2.7.
-
Fork and clone the repository or repositories you wish to develop for.
- For Azure CLI: https://github.com/Azure/azure-cli
- For Azure CLI Extensions: https://github.com/Azure/azure-cli-extensions
- Any other repository that you might have access to that contains CLI extensions.
-
Create a new virtual environment for Python in the root of your clone. You can do this by running:
Python 3.6+ (all platforms):
python -m venv env
or
python3 -m venv env
-
Activate the env virtual environment by running:
Windows CMD.exe:
env\Scripts\activate.bat
Windows Powershell:
env\Scripts\activate.ps1
OSX/Linux (bash):
source env/bin/activate
-
Install
azdev
by running:pip install azdev
-
Complete setup by running:
azdev setup
This will launch the interactive setup process. To see non-interactive options run azdev setup -h
.
If you encounter any bugs with the tool please file an issue in the Issues section of our GitHub repo.
This project has adopted the Microsoft Open Source Code of Conduct.
For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.
If you would like to become an active contributor to this project please follow the instructions provided in Microsoft Azure Projects Contribution Guidelines.
Azure CLI Dev Tools (azdev)
Copyright (c) Microsoft Corporation
All rights reserved.
MIT License
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the ""Software""), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.