azure-deploy-cli 0.1.6__py3-none-any.whl

azure_deploy_cli-0.1.6.dist-info/METADATA

@@ -0,0 +1,678 @@
+Metadata-Version: 2.4
+Name: azure-deploy-cli
+Version: 0.1.6
+Summary: Python CLI for Azure deployment automation - identity, roles, and container apps management
+Author-email: decewei <celinew1221@gmail.com>
+License: Mozilla Public License Version 2.0
+        ==================================
+        
+        1. Definitions
+        --------------
+        
+        1.1. "Contributor"
+            means each individual or legal entity that creates, contributes to
+            the creation of, or owns Covered Software.
+        
+        1.2. "Contributor Version"
+            means the combination of the Contributions of others (if any) used
+            by a Contributor and that particular Contributor's Contribution.
+        
+        1.3. "Contribution"
+            means Covered Software of a particular Contributor.
+        
+        1.4. "Covered Software"
+            means Source Code Form to which the initial Contributor has attached
+            the notice in Exhibit A, the Executable Form of such Source Code
+            Form, and Modifications of such Source Code Form, in each case
+            including portions thereof.
+        
+        1.5. "Incompatible With Secondary Licenses"
+            means
+        
+            (a) that the initial Contributor has attached the notice described
+                in Exhibit B to the Covered Software; or
+        
+            (b) that the Covered Software was made available under the terms of
+                version 1.1 or earlier of the License, but not also under the
+                terms of a Secondary License.
+        
+        1.6. "Executable Form"
+            means any form of the work other than Source Code Form.
+        
+        1.7. "Larger Work"
+            means a work that combines Covered Software with other material, in
+            a separate file or files, that is not Covered Software.
+        
+        1.8. "License"
+            means this document.
+        
+        1.9. "Licensable"
+            means having the right to grant, to the maximum extent possible,
+            whether at the time of the initial grant or subsequently, any and
+            all of the rights conveyed by this License.
+        
+        1.10. "Modifications"
+            means any of the following:
+        
+            (a) any file in Source Code Form that results from an addition to,
+                deletion from, or modification of the contents of Covered
+                Software; or
+        
+            (b) any new file in Source Code Form that contains any Covered
+                Software.
+        
+        1.11. "Patent Claims" of a Contributor
+            means any patent claim(s), including without limitation, method,
+            process, and apparatus claims, in any patent Licensable by such
+            Contributor that would be infringed, but for the grant of the
+            License, by the making, using, selling, offering for sale, having
+            made, import, or transfer of either its Contributions or its
+            Contributor Version.
+        
+        1.12. "Secondary License"
+            means either the GNU General Public License, Version 2.0, the GNU
+            Lesser General Public License, Version 2.1, the GNU Affero General
+            Public License, Version 3.0, or any later versions of those
+            licenses.
+        
+        1.13. "Source Code Form"
+            means the form of the work preferred for making modifications.
+        
+        1.14. "You" (or "Your")
+            means an individual or a legal entity exercising rights under this
+            License. For legal entities, "You" includes any entity that
+            controls, is controlled by, or is under common control with You. For
+            purposes of this definition, "control" means (a) the power, direct
+            or indirect, to cause the direction or management of such entity,
+            whether by contract or otherwise, or (b) ownership of more than
+            fifty percent (50%) of the outstanding shares or beneficial
+            ownership of such entity.
+        
+        2. License Grants and Conditions
+        --------------------------------
+        
+        2.1. Grants
+        
+        Each Contributor hereby grants You a world-wide, royalty-free,
+        non-exclusive license:
+        
+        (a) under intellectual property rights (other than patent or trademark)
+            Licensable by such Contributor to use, reproduce, make available,
+            modify, display, perform, distribute, and otherwise exploit its
+            Contributions, either on an unmodified basis, with Modifications, or
+            as part of a Larger Work; and
+        
+        (b) under Patent Claims of such Contributor to make, use, sell, offer
+            for sale, have made, import, and otherwise transfer either its
+            Contributions or its Contributor Version.
+        
+        2.2. Effective Date
+        
+        The licenses granted in Section 2.1 with respect to any Contribution
+        become effective for each Contribution on the date the Contributor first
+        distributes such Contribution.
+        
+        2.3. Limitations on Grant Scope
+        
+        The licenses granted in this Section 2 are the only rights granted under
+        this License. No additional rights or licenses will be implied from the
+        distribution or licensing of Covered Software under this License.
+        Notwithstanding Section 2.1(b) above, no patent license is granted by a
+        Contributor:
+        
+        (a) for any code that a Contributor has removed from Covered Software;
+            or
+        
+        (b) for infringements caused by: (i) Your and any other third party's
+            modifications of Covered Software, or (ii) the combination of its
+            Contributions with other software (except as part of its Contributor
+            Version); or
+        
+        (c) under Patent Claims infringed by Covered Software in the absence of
+            its Contributions.
+        
+        This License does not grant any rights in the trademarks, service marks,
+        or logos of any Contributor (except as may be necessary to comply with
+        the notice requirements in Section 3.4).
+        
+        2.4. Subsequent Licenses
+        
+        No Contributor makes additional grants as a result of Your choice to
+        distribute the Covered Software under a subsequent version of this
+        License (see Section 10.2) or under the terms of a Secondary License (if
+        permitted under the terms of Section 3.3).
+        
+        2.5. Representation
+        
+        Each Contributor represents that the Contributor believes its
+        Contributions are its original creation(s) or it has sufficient rights
+        to grant the rights to its Contributions conveyed by this License.
+        
+        2.6. Fair Use
+        
+        This License is not intended to limit any rights You have under
+        applicable copyright doctrines of fair use, fair dealing, or other
+        equivalents.
+        
+        2.7. Conditions
+        
+        Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted
+        in Section 2.1.
+        
+        3. Responsibilities
+        -------------------
+        
+        3.1. Distribution of Source Form
+        
+        All distribution of Covered Software in Source Code Form, including any
+        Modifications that You create or to which You contribute, must be under
+        the terms of this License. You must inform recipients that the Source
+        Code Form of the Covered Software is governed by the terms of this
+        License, and how they can obtain a copy of this License. You may not
+        attempt to alter or restrict the recipients' rights in the Source Code
+        Form.
+        
+        3.2. Distribution of Executable Form
+        
+        If You distribute Covered Software in Executable Form then:
+        
+        (a) such Covered Software must also be made available in Source Code
+            Form, as described in Section 3.1, and You must inform recipients of
+            the Executable Form how they can obtain a copy of such Source Code
+            Form by reasonable means in a timely manner, at a charge no more
+            than the cost of distribution to the recipient; and
+        
+        (b) You may distribute such Executable Form under the terms of this
+            License, or sublicense it under different terms, provided that the
+            license for the Executable Form does not attempt to limit or alter
+            the recipients' rights in the Source Code Form under this License.
+        
+        3.3. Distribution of a Larger Work
+        
+        You may create and distribute a Larger Work under terms of Your choice,
+        provided that You also comply with the requirements of this License for
+        the Covered Software. If the Larger Work is a combination of Covered
+        Software with a work governed by one or more Secondary Licenses, and the
+        Covered Software is not Incompatible With Secondary Licenses, this
+        License permits You to additionally distribute such Covered Software
+        under the terms of such Secondary License(s), so that the recipient of
+        the Larger Work may, at their option, further distribute the Covered
+        Software under the terms of either this License or such Secondary
+        License(s).
+        
+        3.4. Notices
+        
+        You may not remove or alter the substance of any license notices
+        (including copyright notices, patent notices, disclaimers of warranty,
+        or limitations of liability) contained within the Source Code Form of
+        the Covered Software, except that You may alter any license notices to
+        the extent required to remedy known factual inaccuracies.
+        
+        3.5. Application of Additional Terms
+        
+        You may choose to offer, and to charge a fee for, warranty, support,
+        indemnity or liability obligations to one or more recipients of Covered
+        Software. However, You may do so only on Your own behalf, and not on
+        behalf of any Contributor. You must make it absolutely clear that any
+        such warranty, support, indemnity, or liability obligation is offered by
+        You alone, and You hereby agree to indemnify every Contributor for any
+        liability incurred by such Contributor as a result of warranty, support,
+        indemnity or liability terms You offer. You may include additional
+        disclaimers of warranty and limitations of liability specific to any
+        jurisdiction.
+        
+        4. Inability to Comply Due to Statute or Regulation
+        ---------------------------------------------------
+        
+        If it is impossible for You to comply with any of the terms of this
+        License with respect to some or all of the Covered Software due to
+        statute, judicial order, or regulation then You must: (a) comply with
+        the terms of this License to the maximum extent possible; and (b)
+        describe the limitations and the code they affect. Such description must
+        be placed in a text file included with all distributions of the Covered
+        Software under this License. Except to the extent prohibited by statute
+        or regulation, such description must be sufficiently detailed for a
+        recipient of ordinary skill to be able to understand it.
+        
+        5. Termination
+        --------------
+        
+        5.1. The rights granted under this License will terminate automatically
+        if You fail to comply with any of its terms. However, if You become
+        compliant, then the rights granted under this License from a particular
+        Contributor are reinstated (a) provisionally, unless and until such
+        Contributor explicitly and finally terminates Your grants, and (b) on an
+        ongoing basis, if such Contributor fails to notify You of the
+        non-compliance by some reasonable means prior to 60 days after You have
+        come back into compliance. Moreover, Your grants from a particular
+        Contributor are reinstated on an ongoing basis if such Contributor
+        notifies You of the non-compliance by some reasonable means, this is the
+        first time You have received notice of non-compliance with this License
+        from such Contributor, and You become compliant prior to 30 days after
+        Your receipt of the notice.
+        
+        5.2. If You initiate litigation against any entity by asserting a patent
+        infringement claim (excluding declaratory judgment actions,
+        counter-claims, and cross-claims) alleging that a Contributor Version
+        directly or indirectly infringes any patent, then the rights granted to
+        You by any and all Contributors for the Covered Software under Section
+        2.1 of this License shall terminate.
+        
+        5.3. In the event of termination under Sections 5.1 or 5.2 above, all
+        end user license agreements (excluding distributors and resellers) which
+        have been validly granted by You or Your distributors under this License
+        prior to termination shall survive termination.
+        
+        ************************************************************************
+        *                                                                      *
+        *  6. Disclaimer of Warranty                                           *
+        *  -------------------------                                           *
+        *                                                                      *
+        *  Covered Software is provided under this License on an "as is"       *
+        *  basis, without warranty of any kind, either expressed, implied, or  *
+        *  statutory, including, without limitation, warranties that the       *
+        *  Covered Software is free of defects, merchantable, fit for a        *
+        *  particular purpose or non-infringing. The entire risk as to the     *
+        *  quality and performance of the Covered Software is with You.        *
+        *  Should any Covered Software prove defective in any respect, You     *
+        *  (not any Contributor) assume the cost of any necessary servicing,   *
+        *  repair, or correction. This disclaimer of warranty constitutes an   *
+        *  essential part of this License. No use of any Covered Software is   *
+        *  authorized under this License except under this disclaimer.         *
+        *                                                                      *
+        ************************************************************************
+        
+        ************************************************************************
+        *                                                                      *
+        *  7. Limitation of Liability                                          *
+        *  --------------------------                                          *
+        *                                                                      *
+        *  Under no circumstances and under no legal theory, whether tort      *
+        *  (including negligence), contract, or otherwise, shall any           *
+        *  Contributor, or anyone who distributes Covered Software as          *
+        *  permitted above, be liable to You for any direct, indirect,         *
+        *  special, incidental, or consequential damages of any character      *
+        *  including, without limitation, damages for lost profits, loss of    *
+        *  goodwill, work stoppage, computer failure or malfunction, or any    *
+        *  and all other commercial damages or losses, even if such party      *
+        *  shall have been informed of the possibility of such damages. This   *
+        *  limitation of liability shall not apply to liability for death or   *
+        *  personal injury resulting from such party's negligence to the       *
+        *  extent applicable law prohibits such limitation. Some               *
+        *  jurisdictions do not allow the exclusion or limitation of           *
+        *  incidental or consequential damages, so this exclusion and          *
+        *  limitation may not apply to You.                                    *
+        *                                                                      *
+        ************************************************************************
+        
+        8. Litigation
+        -------------
+        
+        Any litigation relating to this License may be brought only in the
+        courts of a jurisdiction where the defendant maintains its principal
+        place of business and such litigation shall be governed by laws of that
+        jurisdiction, without reference to its conflict-of-law provisions.
+        Nothing in this Section shall prevent a party's ability to bring
+        cross-claims or counter-claims.
+        
+        9. Miscellaneous
+        ----------------
+        
+        This License represents the complete agreement concerning the subject
+        matter hereof. If any provision of this License is held to be
+        unenforceable, such provision shall be reformed only to the extent
+        necessary to make it enforceable. Any law or regulation which provides
+        that the language of a contract shall be construed against the drafter
+        shall not be used to construe this License against a Contributor.
+        
+        10. Versions of the License
+        ---------------------------
+        
+        10.1. New Versions
+        
+        Mozilla Foundation is the license steward. Except as provided in Section
+        10.3, no one other than the license steward has the right to modify or
+        publish new versions of this License. Each version will be given a
+        distinguishing version number.
+        
+        10.2. Effect of New Versions
+        
+        You may distribute the Covered Software under the terms of the version
+        of the License under which You originally received the Covered Software,
+        or under the terms of any subsequent version published by the license
+        steward.
+        
+        10.3. Modified Versions
+        
+        If you create software not governed by this License, and you want to
+        create a new license for such software, you may create and use a
+        modified version of this License if you rename the license and remove
+        any references to the name of the license steward (except to note that
+        such modified license differs from this License).
+        
+        10.4. Distributing Source Code Form that is Incompatible With Secondary
+        Licenses
+        
+        If You choose to distribute Source Code Form that is Incompatible With
+        Secondary Licenses under the terms of this version of the License, the
+        notice described in Exhibit B of this License must be attached.
+        
+        Exhibit A - Source Code Form License Notice
+        -------------------------------------------
+        
+          This Source Code Form is subject to the terms of the Mozilla Public
+          License, v. 2.0. If a copy of the MPL was not distributed with this
+          file, You can obtain one at https://mozilla.org/MPL/2.0/.
+        
+        If it is not possible or desirable to put the notice in a particular
+        file, then You may include the notice in a location (such as a LICENSE
+        file in a relevant directory) where a recipient would be likely to look
+        for such a notice.
+        
+        You may add additional accurate notices of copyright ownership.
+        
+        Exhibit B - "Incompatible With Secondary Licenses" Notice
+        ---------------------------------------------------------
+        
+          This Source Code Form is "Incompatible With Secondary Licenses", as
+          defined by the Mozilla Public License, v. 2.0.
+        
+Project-URL: Homepage, https://github.com/decewei/azure-deploy-cli
+Project-URL: Repository, https://github.com/decewei/azure-deploy-cli.git
+Project-URL: Issues, https://github.com/decewei/azure-deploy-cli/issues
+Keywords: azure,identity,roles,service-principal
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Mozilla Public License 2.0 (MPL 2.0)
+Classifier: Natural Language :: English
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: azure-identity>=1.14.0
+Requires-Dist: azure-mgmt-appcontainers
+Requires-Dist: azure-mgmt-authorization
+Requires-Dist: azure-mgmt-keyvault
+Requires-Dist: azure-mgmt-msi
+Requires-Dist: python-dotenv>=1.0.0
+Requires-Dist: pydantic>=2.0.0
+Provides-Extra: dev
+Requires-Dist: ruff>=0.1.0; extra == "dev"
+Requires-Dist: mypy>=1.7.0; extra == "dev"
+Requires-Dist: pytest>=7.0; extra == "dev"
+Requires-Dist: pytest-asyncio>=0.21.0; extra == "dev"
+Requires-Dist: coverage>=7.3.0; extra == "dev"
+Requires-Dist: pytest-cov>=4.0.0; extra == "dev"
+Requires-Dist: commitizen>=3.0.0; extra == "dev"
+Requires-Dist: pre-commit>=3.0.0; extra == "dev"
+Requires-Dist: types-setuptools; extra == "dev"
+Dynamic: license-file
+
+# Azure Deploy CLI
+
+Python CLI for Azure deployment automation - manage identities, roles, and Container Apps deployments.
+
+## Version Management and Changelog
+
+This project uses a dual-tool approach:
+
+- **[setuptools-scm](https://setuptools-scm.readthedocs.io/)** - Automatic versioning based on git tags (dynamic at build time)
+- **[commitizen](https://commitizen-tools.github.io/commitizen/)** - Version bumping and tagging with semantic versioning
+- **[git-cliff](https://git-cliff.org/)** - Automatic changelog generation from conventional commits
+
+**Release workflow:**
+1. git-cliff generates changelog from commits since last tag
+2. commitizen bumps version and creates git tag
+3. New version is committed alongside updated changelog
+4. Tag triggers PyPI publishing and GitHub Release
+
+No manual version or changelog updates are needed.
+
+## Quick Start
+
+**Install for development:**
+
+```bash
+cd /path/to/azure-deploy-cli
+pip install -e ".[dev]"
+azd --help
+```
+
+**Use in another project:**
+
+```bash
+pip install -e /path/to/scripts
+```
+
+## Installation
+
+| Method | Command |
+|--------|----------|
+| Local development | `pip install -e ".[dev]"` |
+| Local changes | `pip install -e /path/to/azure-deploy-cli` |
+| From PyPI | `pip install azure-deploy-cli` |
+
+## CLI Commands
+
+### Azure Container Apps (ACA) Deployment
+
+The ACA deployment process is split into two stages for better control:
+
+#### Stage 1: Deploy Revision
+
+Deploy a new container revision without affecting traffic:
+
+```bash
+azd azaca deploy \
+  --resource-group my-rg \
+  --location westus2 \
+  --container-app-env my-env \
+  --logs-workspace-id <workspace-id> \
+  --user-assigned-identity-name my-identity \
+  --container-app my-app \
+  --registry-server myregistry.azurecr.io \
+  --image-name my-image \
+  --stage prod \
+  --target-port 8000 \
+  --cpu 0.5 \
+  --memory 1.0 \
+  --min-replicas 1 \
+  --max-replicas 10 \
+  --keyvault-name my-keyvault \
+  --dockerfile ./Dockerfile \
+  --env-vars ENV_VAR1 ENV_VAR2 \
+  --env-var-secrets SECRET1 SECRET2
+```
+
+This command:
+
+- Creates or updates a new revision with 0% traffic
+- Verifies the revision is healthy and active
+- Outputs the revision name for use in traffic management
+
+#### Stage 2: Update Traffic Weights
+
+Update traffic distribution and deactivate old revisions:
+
+```bash
+azd azaca update-traffic \
+  --resource-group my-rg \
+  --container-app my-app \
+  --label-stage-traffic prod=100 staging=0
+```
+
+This command:
+
+- Updates traffic weights across all specified labels
+- Deactivates revisions not receiving traffic (use `--no-deactivate` to skip)
+- Enables blue-green, canary, and other deployment strategies
+
+**Example Deployment Strategies:**
+
+```bash
+# Blue-Green Deployment (100% to new prod)
+azd azaca update-traffic --resource-group my-rg --container-app my-app \
+  --label-stage-traffic prod=100 staging=0
+
+# Canary Deployment (90% prod, 10% staging)
+azd azaca update-traffic --resource-group my-rg --container-app my-app \
+  --label-stage-traffic prod=90 staging=10
+
+# Multi-Environment (split traffic across multiple labels)
+azd azaca update-traffic --resource-group my-rg --container-app my-app \
+  --label-stage-traffic prod=70 staging=20 dev=10
+```
+
+### Create Service Principal & Assign Roles
+
+```bash
+azd create-and-assign \
+  --sp-name my-app \
+  --roles-config roles.json \
+  --env-vars-files .env.local \
+  --env-file .env.credentials \
+  --print
+```
+
+### Reset Credentials
+
+```bash
+azd reset-credentials --sp-name <SP_NAME> --env-file .env.credentials
+```
+
+### Login with Credentials
+
+```bash
+azd login --env-file .env.credentials
+```
+
+## Python API
+
+```python
+from azure_deploy_cli import create_sp, assign_roles, RoleConfig
+
+# Create service principal
+result = create_sp("my-app")
+print(result.objectId)
+
+# Assign roles from config
+with open('roles.json') as f:
+    config = json.load(f)
+role_config = RoleConfig(**config)
+assign_roles(object_id, subscription_id, role_config)
+```
+
+## Example: Complete Workflow
+
+```bash
+# 1. Create configuration files
+cat > .env.local << 'EOF'
+SUBSCRIPTION_ID=<YOUR_SUBSCRIPTION>
+RESOURCE_GROUP=<YOUR_RG>
+OPENAI_RESOURCE_NAME=<YOUR_OPENAI>
+EOF
+
+cat > roles-config.json << 'EOF'
+{
+  "description": "My App Roles",
+  "roles": [
+    {
+      "type": "rbac",
+      "role": "Cognitive Services User",
+      "scope": "/subscriptions/${SUBSCRIPTION_ID}/resourceGroups/${RESOURCE_GROUP}/providers/Microsoft.CognitiveServices/accounts/${OPENAI_RESOURCE_NAME}"
+    },
+    {
+      "type": "cosmos-db",
+      "account": "${COSMOS_ACCOUNT}",
+      "role": "Cosmos DB Built-in Data Contributor",
+      "scope": "/"
+    }
+  ]
+}
+EOF
+
+# 2. Create service principal and assign roles
+azd create-and-assign \
+  --sp-name my-app-sp \
+  --roles-config roles-config.json \
+  --env-vars-files .env.local \
+  --env-file .env.credentials \
+  --print
+```
+
+## Development
+
+```bash
+make install-dev    # Install with dev tools
+make build          # Run lint + type-check + test
+make lint           # Code linting with ruff
+make format         # Auto-format code
+make type-check     # Type checking with mypy
+make test           # Run tests with pytest
+make clean          # Remove build artifacts
+```
+
+Commit using [Conventional Commits](https://www.conventionalcommits.org/) format (e.g., `feat: add feature`, `fix: resolve bug`)
+
+## Scripting and Output Handling
+
+This CLI is designed for both interactive use and automated scripting. To support this, it follows the standard practice of separating output streams:
+
+- **`stderr`**: All human-readable logs, progress indicators, and error messages are sent to the standard error stream.
+- **`stdout`**: All machine-readable output (e.g., revision names, IDs) is sent to the standard output stream.
+
+This allows you to cleanly capture command output while still seeing logs in your terminal.
+
+### Capturing Output
+
+To save the parsable output to a file, redirect `stdout`:
+
+```bash
+azd azaca deploy ... > deployment_output.txt
+```
+
+The `deployment_output.txt` file will contain only the `REVISION_NAME=...` and `REVISION_URL=...` lines, without any of the logging messages.
+
+### Silencing Logs
+
+If you want to completely suppress the log messages (e.g., in a CI/CD script), redirect `stderr` to `/dev/null`:
+
+```bash
+azd azaca deploy ... 2>/dev/null
+```
+
+### Parsing Output in Scripts
+
+You can pipe the output to standard Unix tools like `grep` and `cut` to extract specific values.
+
+#### Example: Get the revision name
+
+```bash
+REVISION_NAME=$(azd azaca deploy ... 2>/dev/null | grep REVISION_NAME | cut -d'=' -f2)
+echo "Deployed revision: $REVISION_NAME"
+```
+
+### Controlling Log Verbosity
+
+Use the `--log-level` option to control the verbosity of the log output. The default level is `info`.
+
+Available levels: `debug`, `info`, `warning`, `error`, `critical`, `none`.
+
+#### Example: Enable debug logging
+
+```bash
+azd --log-level debug azaca deploy ...
+```
+
+#### Example: Suppress all logs
+
+```bash
+azd --log-level none azaca deploy ...
+```
+
+## License
+
+Mozilla Public License 2.0 - See LICENSE file for details