asa-api-cli 0.1.0__tar.gz

asa_api_cli-0.1.0/.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,78 @@
+name: Bug Report
+description: Report a bug or unexpected behavior
+labels: ["type: bug"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to report a bug! Please fill out the form below.
+
+  - type: textarea
+    id: description
+    attributes:
+      label: Description
+      description: A clear and concise description of what the bug is.
+      placeholder: Describe the bug...
+    validations:
+      required: true
+
+  - type: input
+    id: command
+    attributes:
+      label: Command
+      description: What command were you running?
+      placeholder: "asa campaigns list"
+    validations:
+      required: true
+
+  - type: textarea
+    id: output
+    attributes:
+      label: Output/Error
+      description: The output or error message you received.
+      render: shell
+    validations:
+      required: true
+
+  - type: textarea
+    id: expected
+    attributes:
+      label: Expected Behavior
+      description: What you expected to happen.
+    validations:
+      required: true
+
+  - type: input
+    id: version
+    attributes:
+      label: CLI Version
+      description: Output of `asa --version`
+      placeholder: "search-ads-cli 0.1.0 (search-ads-api 0.1.0)"
+    validations:
+      required: true
+
+  - type: input
+    id: python-version
+    attributes:
+      label: Python Version
+      description: What version of Python are you using?
+      placeholder: "3.13.0"
+    validations:
+      required: true
+
+  - type: dropdown
+    id: os
+    attributes:
+      label: Operating System
+      options:
+        - macOS
+        - Linux
+        - Windows
+    validations:
+      required: true
+
+  - type: textarea
+    id: additional
+    attributes:
+      label: Additional Context
+      description: Any other context about the problem.

asa_api_cli-0.1.0/.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,5 @@
+blank_issues_enabled: false
+contact_links:
+  - name: Question or Discussion
+    url: https://github.com/SamPetherbridge/search-ads-cli/discussions
+    about: Ask questions or start a discussion

asa_api_cli-0.1.0/.github/ISSUE_TEMPLATE/feature_request.yml

@@ -0,0 +1,39 @@
+name: Feature Request
+description: Suggest a new feature or enhancement
+labels: ["type: feature"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for suggesting a feature! Please fill out the form below.
+
+  - type: textarea
+    id: problem
+    attributes:
+      label: Problem Statement
+      description: What problem would this feature solve? Is it related to a frustration?
+      placeholder: I'm always frustrated when...
+    validations:
+      required: true
+
+  - type: textarea
+    id: solution
+    attributes:
+      label: Proposed Solution
+      description: Describe the solution you'd like to see. If it's a new command, show the usage.
+      placeholder: |
+        asa campaigns archive --older-than 30d
+    validations:
+      required: true
+
+  - type: textarea
+    id: alternatives
+    attributes:
+      label: Alternatives Considered
+      description: Have you considered any alternative solutions or workarounds?
+
+  - type: textarea
+    id: additional
+    attributes:
+      label: Additional Context
+      description: Any other context, screenshots, or examples.

asa_api_cli-0.1.0/.github/dependabot.yml

@@ -0,0 +1,24 @@
+version: 2
+updates:
+  - package-ecosystem: "pip"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    commit-message:
+      prefix: "⬆️"
+    labels:
+      - "dependencies"
+    groups:
+      python-packages:
+        patterns:
+          - "*"
+
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    commit-message:
+      prefix: "👷"
+    labels:
+      - "dependencies"
+      - "github-actions"

asa_api_cli-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,46 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.13"]
+
+    steps:
+      - uses: actions/checkout@v6
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v7
+        with:
+          version: "latest"
+
+      - name: Set up Python ${{ matrix.python-version }}
+        run: uv python install ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: uv sync --extra dev
+
+      - name: Run linting
+        run: uv run ruff check .
+
+      - name: Run formatting check
+        run: uv run ruff format --check .
+
+      - name: Run type checking
+        run: uv run mypy asa_api_cli
+
+      - name: Run tests
+        run: uv run pytest --cov=asa_api_cli --cov-report=xml
+
+      - name: Upload coverage to Codecov
+        uses: codecov/codecov-action@v5
+        with:
+          file: ./coverage.xml
+          fail_ci_if_error: false

asa_api_cli-0.1.0/.github/workflows/publish.yml

@@ -0,0 +1,29 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write  # Required for trusted publishing
+
+    steps:
+      - uses: actions/checkout@v6
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v7
+        with:
+          version: "latest"
+
+      - name: Set up Python
+        run: uv python install 3.13
+
+      - name: Build package
+        run: uv build
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

asa_api_cli-0.1.0/.gitignore

@@ -0,0 +1,55 @@
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# Virtual environments
+.venv/
+venv/
+ENV/
+
+# IDE
+.idea/
+.vscode/
+*.swp
+*.swo
+
+# Testing
+.pytest_cache/
+.coverage
+coverage.xml
+htmlcov/
+.tox/
+.nox/
+
+# mypy
+.mypy_cache/
+
+# ruff
+.ruff_cache/
+
+# Environment
+.env
+.env.local
+*.pem
+
+# OS
+.DS_Store
+Thumbs.db

asa_api_cli-0.1.0/LICENSE

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

asa_api_cli-0.1.0/PKG-INFO

@@ -0,0 +1,196 @@
+Metadata-Version: 2.4
+Name: asa-api-cli
+Version: 0.1.0
+Summary: Command-line interface for Apple Search Ads campaign management
+Project-URL: Homepage, https://github.com/SamPetherbridge/asa-api-cli
+Project-URL: Repository, https://github.com/SamPetherbridge/asa-api-cli
+Project-URL: Issues, https://github.com/SamPetherbridge/asa-api-cli/issues
+Author-email: Sam Petherbridge <hello@peth.me>
+License-Expression: MIT
+License-File: LICENSE
+Keywords: advertising,apple,campaign-management,cli,search-ads
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Typing :: Typed
+Requires-Python: >=3.13
+Requires-Dist: asa-api-client>=0.1.0
+Requires-Dist: rich>=13.9.0
+Requires-Dist: typer>=0.13.0
+Provides-Extra: dev
+Requires-Dist: mypy>=1.13.0; extra == 'dev'
+Requires-Dist: pytest-asyncio>=0.24.0; extra == 'dev'
+Requires-Dist: pytest-cov>=6.0.0; extra == 'dev'
+Requires-Dist: pytest>=8.3.0; extra == 'dev'
+Requires-Dist: ruff>=0.8.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# ASA API CLI
+
+[![PyPI version](https://img.shields.io/pypi/v/asa-api-cli.svg)](https://pypi.org/project/asa-api-cli/)
+[![Python](https://img.shields.io/pypi/pyversions/asa-api-cli.svg)](https://pypi.org/project/asa-api-cli/)
+[![License](https://img.shields.io/github/license/SamPetherbridge/asa-api-cli.svg)](https://github.com/SamPetherbridge/asa-api-cli/blob/main/LICENSE)
+[![CI](https://github.com/SamPetherbridge/asa-api-cli/actions/workflows/ci.yml/badge.svg)](https://github.com/SamPetherbridge/asa-api-cli/actions/workflows/ci.yml)
+
+A command-line interface for managing Apple Search Ads campaigns.
+
+Built on top of [asa-api-client](https://github.com/SamPetherbridge/asa-api-client).
+
+## Installation
+
+Using [uv](https://docs.astral.sh/uv/) (recommended):
+
+```bash
+uv tool install asa-api-cli
+```
+
+Using pip:
+
+```bash
+pip install asa-api-cli
+```
+
+Using pipx:
+
+```bash
+pipx install asa-api-cli
+```
+
+## Setup
+
+Set up your Apple Search Ads API credentials:
+
+```bash
+export ASA_CLIENT_ID="SEARCHADS.your-client-id"
+export ASA_TEAM_ID="SEARCHADS.your-team-id"
+export ASA_KEY_ID="your-key-id"
+export ASA_ORG_ID="123456"
+export ASA_PRIVATE_KEY_PATH="/path/to/private-key.pem"
+```
+
+Or use a `.env` file in your working directory.
+
+Test your credentials:
+
+```bash
+asa auth test
+```
+
+## Commands
+
+### Campaigns
+
+```bash
+# List all enabled campaigns
+asa campaigns list
+
+# List all campaigns (including paused)
+asa campaigns list --all
+
+# List with 7-day spend data
+asa campaigns list --with-spend
+
+# Get a specific campaign
+asa campaigns get 123456789
+
+# Output as JSON
+asa campaigns list --json
+```
+
+### Ad Groups
+
+```bash
+# List ad groups in a campaign
+asa ad-groups list 123456789
+```
+
+### Keywords
+
+```bash
+# List keywords in an ad group
+asa keywords list 123456789 987654321
+```
+
+### Reports
+
+```bash
+# Campaign performance report
+asa reports campaigns --start 2024-01-01 --end 2024-01-31
+
+# Keyword report
+asa reports keywords 123456789 --start 2024-01-01 --end 2024-01-31
+
+# Export to CSV
+asa reports campaigns --start 2024-01-01 --end 2024-01-31 --output report.csv
+```
+
+### Brand Campaigns
+
+Create brand protection campaigns for your app:
+
+```bash
+# Interactive mode (recommended)
+asa brand
+
+# With arguments
+asa brand "My App Name" -v "My App" -c US -c GB
+
+# All standard countries
+asa brand "My App Name" --country all
+
+# Preview without creating
+asa brand "My App Name" -c US --dry-run
+```
+
+### Campaign Expansion
+
+Expand existing campaigns to new markets:
+
+```bash
+# Interactive mode
+asa optimize expand
+
+# With filters
+asa optimize expand --type Generic --match EM
+
+# Preview
+asa optimize expand --dry-run
+```
+
+### Bid Optimization
+
+Check and fix bid discrepancies:
+
+```bash
+# Check bids
+asa optimize bid-check
+
+# Auto-fix discrepancies
+asa optimize bid-check --auto-fix
+
+# With threshold
+asa optimize bid-check --threshold 0.05
+```
+
+## Shell Completion
+
+Install shell completion for your shell:
+
+```bash
+# Bash
+asa --install-completion bash
+
+# Zsh
+asa --install-completion zsh
+
+# Fish
+asa --install-completion fish
+```
+
+## License
+
+MIT License - Copyright (c) 2025 Peth Pty Ltd

asa_api_cli-0.1.0/README.md

@@ -0,0 +1,165 @@
+# ASA API CLI
+
+[![PyPI version](https://img.shields.io/pypi/v/asa-api-cli.svg)](https://pypi.org/project/asa-api-cli/)
+[![Python](https://img.shields.io/pypi/pyversions/asa-api-cli.svg)](https://pypi.org/project/asa-api-cli/)
+[![License](https://img.shields.io/github/license/SamPetherbridge/asa-api-cli.svg)](https://github.com/SamPetherbridge/asa-api-cli/blob/main/LICENSE)
+[![CI](https://github.com/SamPetherbridge/asa-api-cli/actions/workflows/ci.yml/badge.svg)](https://github.com/SamPetherbridge/asa-api-cli/actions/workflows/ci.yml)
+
+A command-line interface for managing Apple Search Ads campaigns.
+
+Built on top of [asa-api-client](https://github.com/SamPetherbridge/asa-api-client).
+
+## Installation
+
+Using [uv](https://docs.astral.sh/uv/) (recommended):
+
+```bash
+uv tool install asa-api-cli
+```
+
+Using pip:
+
+```bash
+pip install asa-api-cli
+```
+
+Using pipx:
+
+```bash
+pipx install asa-api-cli
+```
+
+## Setup
+
+Set up your Apple Search Ads API credentials:
+
+```bash
+export ASA_CLIENT_ID="SEARCHADS.your-client-id"
+export ASA_TEAM_ID="SEARCHADS.your-team-id"
+export ASA_KEY_ID="your-key-id"
+export ASA_ORG_ID="123456"
+export ASA_PRIVATE_KEY_PATH="/path/to/private-key.pem"
+```
+
+Or use a `.env` file in your working directory.
+
+Test your credentials:
+
+```bash
+asa auth test
+```
+
+## Commands
+
+### Campaigns
+
+```bash
+# List all enabled campaigns
+asa campaigns list
+
+# List all campaigns (including paused)
+asa campaigns list --all
+
+# List with 7-day spend data
+asa campaigns list --with-spend
+
+# Get a specific campaign
+asa campaigns get 123456789
+
+# Output as JSON
+asa campaigns list --json
+```
+
+### Ad Groups
+
+```bash
+# List ad groups in a campaign
+asa ad-groups list 123456789
+```
+
+### Keywords
+
+```bash
+# List keywords in an ad group
+asa keywords list 123456789 987654321
+```
+
+### Reports
+
+```bash
+# Campaign performance report
+asa reports campaigns --start 2024-01-01 --end 2024-01-31
+
+# Keyword report
+asa reports keywords 123456789 --start 2024-01-01 --end 2024-01-31
+
+# Export to CSV
+asa reports campaigns --start 2024-01-01 --end 2024-01-31 --output report.csv
+```
+
+### Brand Campaigns
+
+Create brand protection campaigns for your app:
+
+```bash
+# Interactive mode (recommended)
+asa brand
+
+# With arguments
+asa brand "My App Name" -v "My App" -c US -c GB
+
+# All standard countries
+asa brand "My App Name" --country all
+
+# Preview without creating
+asa brand "My App Name" -c US --dry-run
+```
+
+### Campaign Expansion
+
+Expand existing campaigns to new markets:
+
+```bash
+# Interactive mode
+asa optimize expand
+
+# With filters
+asa optimize expand --type Generic --match EM
+
+# Preview
+asa optimize expand --dry-run
+```
+
+### Bid Optimization
+
+Check and fix bid discrepancies:
+
+```bash
+# Check bids
+asa optimize bid-check
+
+# Auto-fix discrepancies
+asa optimize bid-check --auto-fix
+
+# With threshold
+asa optimize bid-check --threshold 0.05
+```
+
+## Shell Completion
+
+Install shell completion for your shell:
+
+```bash
+# Bash
+asa --install-completion bash
+
+# Zsh
+asa --install-completion zsh
+
+# Fish
+asa --install-completion fish
+```
+
+## License
+
+MIT License - Copyright (c) 2025 Peth Pty Ltd

asa_api_cli-0.1.0/asa_api_cli/__init__.py

@@ -0,0 +1,15 @@
+"""Command-line interface for Apple Search Ads.
+
+This module provides a CLI for interacting with the Apple Search Ads API.
+
+Usage:
+    asa --help
+    asa campaigns list
+    asa reports campaigns --start 2024-01-01 --end 2024-01-31
+"""
+
+from asa_api_cli.main import app
+
+__all__ = ["app"]
+
+__version__ = "0.1.0"