adop-cli 0.1.3__py3-none-any.whl

adop_cli-0.1.3.dist-info/METADATA

@@ -0,0 +1,429 @@
+Metadata-Version: 2.4
+Name: adop-cli
+Version: 0.1.3
+Summary: CLI tool to trigger Azure DevOps pipelines
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: click>=8.0
+Requires-Dist: rich>=13.0
+Requires-Dist: requests>=2.28
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
+Dynamic: license-file
+
+# Azure DevOps Pipeline CLI
+
+A command-line tool to trigger and manage Azure DevOps pipelines with ease.
+
+## Features
+
+- **Trigger Pipelines** - Start builds with a single command
+- **Watch Progress** - Real-time build status with progress bar
+- **Build Management** - View status, logs, cancel, compare builds
+- **Favorites** - Save and reuse common build configurations
+- **Shell Completion** - Tab-complete pipeline aliases and branches
+- **Fuzzy Matching** - Suggests corrections for typos
+
+## Installation
+
+### Homebrew (macOS/Linux)
+
+```bash
+brew tap SAGARSURI/tap
+brew install adop-cli
+```
+
+### pip
+
+```bash
+pip install adop-cli
+```
+
+### From Source
+
+```bash
+git clone https://github.com/SAGARSURI/adop.git
+cd adop
+python3 -m venv .venv
+source .venv/bin/activate
+pip install -e .
+```
+
+## Setup
+
+### 1. Configure Azure DevOps Connection
+
+```bash
+ado-pipeline config init
+```
+
+You'll be prompted to enter:
+- **Organization** - Your Azure DevOps organization name
+- **Project** - Your Azure DevOps project name
+- **PAT** - Personal Access Token
+
+**Required PAT Permissions:**
+- Build: Read & execute
+- Code: Read
+- User Profile: Read (optional, for `--mine` flag)
+
+### 2. Add Pipelines
+
+After configuring, add pipelines you want to manage:
+
+```bash
+# Import pipelines from Azure DevOps (interactive)
+ado-pipeline pipeline import
+
+# Or add manually
+ado-pipeline pipeline add my-build "My Pipeline Name" --description "Build description"
+
+# Add with parameters
+ado-pipeline pipeline add android-build "Android_Build" \
+  --param "outputFormat:choice:apk:apk,aab" \
+  --param "deploy:boolean:false" \
+  --param "releaseNotes:string:"
+```
+
+### 3. Enable Shell Completion (Optional)
+
+```bash
+# Bash - add to ~/.bashrc
+eval "$(_ADO_PIPELINE_COMPLETE=bash_source ado-pipeline)"
+
+# Zsh - add to ~/.zshrc
+eval "$(_ADO_PIPELINE_COMPLETE=zsh_source ado-pipeline)"
+```
+
+This enables tab-completion for pipeline aliases and git branches.
+
+## Quick Start
+
+```bash
+# List available pipelines
+ado-pipeline list
+
+# See what would be triggered (dry-run)
+ado-pipeline plan my-build
+
+# Trigger a build
+ado-pipeline apply my-build
+
+# Trigger and watch progress
+ado-pipeline apply my-build -y -w
+
+# Check build status
+ado-pipeline status
+
+# Open build in browser
+ado-pipeline open <BUILD_ID>
+```
+
+## Commands
+
+### Trigger Pipelines
+
+#### Plan Mode (Dry Run)
+
+Preview what will be triggered without making API calls:
+
+```bash
+ado-pipeline plan my-build
+ado-pipeline plan my-build --branch feature/my-feature
+ado-pipeline plan my-build --branch main --deploy
+```
+
+#### Apply Mode (Trigger)
+
+Actually trigger the pipeline:
+
+```bash
+# Basic trigger (prompts for confirmation)
+ado-pipeline apply my-build
+
+# Skip confirmation
+ado-pipeline apply my-build -y
+
+# Skip confirmation and watch progress
+ado-pipeline apply my-build -y -w
+
+# With options
+ado-pipeline apply my-build --branch main --deploy --output-format aab
+```
+
+### Build Management
+
+#### View Build Status
+
+```bash
+# Show recent builds
+ado-pipeline status
+
+# Show more builds
+ado-pipeline status -n 20
+
+# Filter by pipeline
+ado-pipeline status -p my-build
+
+# Show only your builds
+ado-pipeline status --mine
+```
+
+#### View Build Logs
+
+```bash
+# Show logs for a build
+ado-pipeline logs <BUILD_ID>
+
+# Stream logs in real-time
+ado-pipeline logs <BUILD_ID> -f
+```
+
+#### Cancel a Build
+
+```bash
+ado-pipeline cancel <BUILD_ID>
+ado-pipeline cancel <BUILD_ID> -y    # Skip confirmation
+```
+
+#### Open Build in Browser
+
+```bash
+ado-pipeline open <BUILD_ID>
+```
+
+#### Compare Two Builds
+
+```bash
+ado-pipeline diff <BUILD_ID_1> <BUILD_ID_2>
+```
+
+Shows side-by-side comparison of pipeline, branch, result, duration, and parameters.
+
+### Pipeline Management
+
+#### List Configured Pipelines
+
+```bash
+ado-pipeline pipeline list
+```
+
+#### Add a Pipeline
+
+```bash
+# Basic
+ado-pipeline pipeline add <alias> "<Azure DevOps Pipeline Name>"
+
+# With description
+ado-pipeline pipeline add my-build "My_Build_Pipeline" --description "Main build"
+
+# With parameters
+ado-pipeline pipeline add my-build "My_Build_Pipeline" \
+  --param "outputFormat:choice:apk:apk,aab" \
+  --param "deploy:boolean:false" \
+  --param "environment:string:dev"
+```
+
+Parameter format: `name:type:default[:choices]`
+- Types: `string`, `boolean`, `choice`
+- For choice type, add comma-separated options after default
+
+#### Import from Azure DevOps
+
+```bash
+# Interactive import from remote
+ado-pipeline pipeline import
+```
+
+This fetches available pipelines from Azure DevOps and lets you add them interactively.
+
+#### Remove a Pipeline
+
+```bash
+ado-pipeline pipeline remove <alias>
+```
+
+### Favorites
+
+Save frequently used build configurations for quick access.
+
+#### Save a Favorite
+
+```bash
+# Save with deploy enabled
+ado-pipeline fav add quick-build my-build --deploy
+
+# Save with specific branch
+ado-pipeline fav add release-build my-prod --branch main --deploy
+```
+
+#### List Favorites
+
+```bash
+ado-pipeline fav list
+```
+
+#### Run a Favorite
+
+```bash
+ado-pipeline fav run quick-build
+ado-pipeline fav run quick-build -y -w    # Skip confirmation + watch
+```
+
+#### Remove a Favorite
+
+```bash
+ado-pipeline fav remove quick-build
+```
+
+### Configuration
+
+```bash
+# Initialize or update configuration
+ado-pipeline config init
+
+# Show current configuration
+ado-pipeline config show
+```
+
+## Parameters
+
+Parameters are defined per-pipeline when you add them. Common parameter types:
+
+| Type | Description | Example |
+|------|-------------|---------|
+| `string` | Free text input | `--release-notes "Bug fixes"` |
+| `boolean` | True/false flag | `--deploy` / `--no-deploy` |
+| `choice` | Select from options | `--output-format apk` |
+
+### Common Options
+
+| Option | Description |
+|--------|-------------|
+| `--branch`, `-b` | Branch to build (default: current branch) |
+| `--yes`, `-y` | Skip confirmation prompt |
+| `--watch`, `-w` | Watch build progress until completion |
+
+## Configuration Files
+
+| File | Purpose |
+|------|---------|
+| `~/.azure-pipeline-cli/config.json` | PAT and organization settings |
+| `~/.azure-pipeline-cli/pipelines.json` | Pipeline definitions |
+| `~/.azure-pipeline-cli/favorites.json` | Saved favorite configurations |
+
+All files have `0600` permissions (owner read/write only) since they may contain sensitive data.
+
+## Troubleshooting
+
+### "Pipeline not found"
+
+The CLI suggests similar names if you make a typo:
+```
+Error: Pipeline 'my-bild' not found. Did you mean: my-build?
+```
+
+Run `ado-pipeline pipeline list` to see all available aliases.
+
+### "No pipelines configured"
+
+Add pipelines first:
+```bash
+ado-pipeline pipeline import   # Import from Azure DevOps
+# or
+ado-pipeline pipeline add <alias> "<pipeline-name>"
+```
+
+### "PAT not configured"
+
+Run `ado-pipeline config init` and enter your credentials.
+
+### "Branch not found"
+
+The branch must exist on the remote. Push it first:
+```bash
+git push -u origin <branch>
+```
+
+### "Could not determine current user"
+
+The `--mine` flag requires User Profile read permission on your PAT. The command will continue without filtering if this fails.
+
+### Shell completion not working
+
+Make sure you've added the eval command to your shell config and restarted your terminal.
+
+### Build stuck or need to cancel
+
+```bash
+ado-pipeline cancel <BUILD_ID> -y
+```
+
+## Development
+
+### Setup
+
+```bash
+git clone https://github.com/SAGARSURI/adop.git
+cd adop
+python3 -m venv .venv
+source .venv/bin/activate
+pip install -e ".[dev]"
+```
+
+### Running Tests
+
+```bash
+pytest tests/ -v
+```
+
+### Project Structure
+
+```
+src/ado_pipeline/
+├── __init__.py      # Version
+├── api.py           # Azure DevOps API client
+├── cli.py           # CLI commands (click)
+├── config.py        # Configuration management
+├── favorites.py     # Favorites system
+├── pipelines.py     # Pipeline definitions
+└── plan.py          # Execution plan generation
+```
+
+## CI/CD
+
+### Automated Testing
+
+Tests run automatically on:
+- Push to `main`
+- Pull requests to `main`
+
+Tests run against Python 3.10, 3.11, and 3.12.
+
+[![CI](https://github.com/SAGARSURI/adop/actions/workflows/ci.yml/badge.svg)](https://github.com/SAGARSURI/adop/actions/workflows/ci.yml)
+
+### Releasing
+
+Releases are automated via GitHub Actions:
+
+1. Update version in `pyproject.toml`
+2. Commit and tag:
+   ```bash
+   git add pyproject.toml
+   git commit -m "chore: bump version to X.Y.Z"
+   git tag vX.Y.Z
+   git push origin main --tags
+   ```
+3. The release workflow automatically:
+   - Runs tests
+   - Publishes to PyPI
+   - Updates Homebrew tap
+
+## Contributing
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
+
+## License
+
+MIT License - see [LICENSE](LICENSE) for details.

adop_cli-0.1.3.dist-info/RECORD

@@ -0,0 +1,13 @@
+ado_pipeline/__init__.py,sha256=tzGtIYUZ6OvzngkK0U7ARyBhiwqb8XjTSyzBSxV_biY,64
+ado_pipeline/api.py,sha256=XwmQjqISxwT3AbYTH_nbvGZECFUr6foVIDquNKShw5A,8971
+ado_pipeline/cli.py,sha256=P9OQmNenKn7KbM5hbBulCy3t_A2ARtTtZoTnggGh1lY,44351
+ado_pipeline/config.py,sha256=SHBxV3klX_wI5F5YyLp_1meFoikFo7GZZNGAxfaCgK0,6491
+ado_pipeline/favorites.py,sha256=_YyonRerHTVKSGSHn3HAKYa1clcMykmaIdvQDtrrU2U,3315
+ado_pipeline/pipelines.py,sha256=rPEN6yKilNN9a5w79DUP4kXs8TLgdC3qSZ5onU4-rLU,4990
+ado_pipeline/plan.py,sha256=HUkxO16FKGyi8muBm1GLOxgDt5rSjXqD1oC1EtUHcXQ,4799
+adop_cli-0.1.3.dist-info/licenses/LICENSE,sha256=dUhuoK-TCRQMpuLEAdfme-qPSJI0TlcH9jlNxeg9_EQ,1056
+adop_cli-0.1.3.dist-info/METADATA,sha256=-FvEihTEmtrVFMDDIFMbCsZCpSbGvRJBVlIl0mdaoY4,8984
+adop_cli-0.1.3.dist-info/WHEEL,sha256=qELbo2s1Yzl39ZmrAibXA2jjPLUYfnVhUNTlyF1rq0Y,92
+adop_cli-0.1.3.dist-info/entry_points.txt,sha256=O_LBtUGzJ5E06wf6Te8v2l79F3JsXZ2-LjGv3ZtD1hI,55
+adop_cli-0.1.3.dist-info/top_level.txt,sha256=lWHKTJxtd4lYXhOUvLMB0oSo-3bThqnK-gpr1VB-LSU,13
+adop_cli-0.1.3.dist-info/RECORD,,

adop_cli-0.1.3.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.10.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

adop_cli-0.1.3.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+ado-pipeline = ado_pipeline.cli:main

adop_cli-0.1.3.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024
+
+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.

adop_cli-0.1.3.dist-info/top_level.txt

@@ -0,0 +1 @@
+ado_pipeline