google-analytics-cli 0.1.0rc1__py3-none-any.whl

google_analytics_cli-0.1.0rc1.dist-info/METADATA

@@ -0,0 +1,269 @@
+Metadata-Version: 2.4
+Name: google-analytics-cli
+Version: 0.1.0rc1
+Summary: Command-line interface for Google Analytics 4
+Project-URL: Homepage, https://github.com/daidalytics/google-analytics-cli
+Project-URL: Repository, https://github.com/daidalytics/google-analytics-cli
+Project-URL: Issues, https://github.com/daidalytics/google-analytics-cli/issues
+Author: Gunnar Griese
+License: MIT
+Keywords: analytics,cli,ga4,google-analytics
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Internet :: WWW/HTTP
+Requires-Python: >=3.10
+Requires-Dist: google-api-python-client>=2.0
+Requires-Dist: google-auth-oauthlib>=1.0
+Requires-Dist: google-auth>=2.0
+Requires-Dist: packaging>=23.0
+Requires-Dist: platformdirs>=4.0
+Requires-Dist: questionary>=2.0
+Requires-Dist: rich>=13.0
+Requires-Dist: typer[all]>=0.9.0
+Description-Content-Type: text/markdown
+
+# GA CLI
+
+Command-line interface for Google Analytics 4.
+
+Manage GA4 accounts, properties, data streams, and run reports — all from your terminal.
+
+## Features
+
+- **Authentication** — OAuth 2.0 (browser-based) and service account support
+- **Account management** — List, inspect, and update GA4 accounts
+- **Property management** — List, create, inspect, update, and delete GA4 properties
+- **Data stream management** — List, create, inspect, update, and delete web, Android, and iOS data streams
+- **Custom dimensions & metrics** — List, create, update, and archive custom definitions
+- **Key events** — List, create, update, and delete key events (conversions)
+- **Reporting** — Run custom reports, pivot reports, real-time reports with live polling, check compatibility, and build reports interactively
+- **Flexible output** — Table (default), JSON, and compact output formats
+- **Self-update** — Check for and install updates via `ga upgrade`
+- **Schema introspection** — `ga --describe` outputs JSON Schema for all commands (agent/MCP-ready)
+- **Shell completions** — Generate completion scripts for bash, zsh, and fish
+- **Interactive setup** — Guided configuration wizard via `ga config setup`
+
+## Installation
+
+### From PyPI (recommended)
+
+```bash
+# pipx (recommended for CLI tools — isolated env)
+pipx install google-analytics-cli
+
+# uv
+uv tool install google-analytics-cli
+
+# pip
+pip install google-analytics-cli
+```
+
+### Quick install (script)
+
+```bash
+curl -fsSL https://raw.githubusercontent.com/daidalytics/google-analytics-cli/master/install.sh | bash
+```
+
+### From GitHub
+
+```bash
+# With uv
+uv pip install git+https://github.com/daidalytics/google-analytics-cli.git
+
+# With pip
+pip install git+https://github.com/daidalytics/google-analytics-cli.git
+```
+
+### From source
+
+```bash
+git clone https://github.com/daidalytics/google-analytics-cli.git
+cd google-analytics-cli
+uv sync
+uv run ga --help
+```
+
+### One-off execution (no install)
+
+```bash
+uvx --from git+https://github.com/daidalytics/google-analytics-cli.git ga --help
+```
+
+## Quick Start
+
+```bash
+# 1. Authenticate
+ga auth login
+
+# 2. List your accounts
+ga accounts list
+
+# 3. List properties for an account
+ga properties list --account-id 123456789
+
+# 4. Run a report
+ga reports run --property-id 987654321 \
+  --metrics sessions,totalUsers \
+  --dimensions date \
+  --start-date 7daysAgo
+```
+
+## Setup
+
+### 1. Create OAuth credentials
+
+Create an OAuth 2.0 Client ID in the [Google Cloud Console](https://console.cloud.google.com/apis/credentials):
+
+1. Go to **APIs & Services > Credentials**
+2. Click **Create Credentials > OAuth client ID**
+3. Choose **Desktop app** as the application type
+4. Download the JSON file
+
+Make sure the following APIs are enabled in your GCP project:
+- Google Analytics Admin API
+- Google Analytics Data API
+
+### 2. Configure client credentials
+
+Copy the downloaded `client_secret.json` to the GA CLI config directory:
+
+```bash
+mkdir -p ~/.config/ga-cli
+cp /path/to/client_secret.json ~/.config/ga-cli/client_secret.json
+```
+
+Alternatively, set environment variables:
+
+```bash
+export GA_CLI_CLIENT_ID="your-client-id"
+export GA_CLI_CLIENT_SECRET="your-client-secret"
+```
+
+### 3. Authenticate
+
+```bash
+ga auth login
+```
+
+This opens your browser for Google OAuth consent and stores the token locally at `~/.config/ga-cli/credentials.json`.
+
+#### Service account (alternative)
+
+```bash
+ga auth login --service-account /path/to/key.json
+```
+
+Or set an environment variable:
+
+```bash
+export GA_CLI_SERVICE_ACCOUNT="/path/to/key.json"
+```
+
+## Command Reference
+
+| Command | Subcommands | Description |
+|---------|-------------|-------------|
+| `ga auth` | `login`, `logout`, `status` | Manage authentication |
+| `ga config` | `setup`, `get`, `set`, `unset`, `path`, `reset` | Manage CLI configuration |
+| `ga accounts` | `list`, `get`, `update` | List, inspect, and update GA4 accounts |
+| `ga account-summaries` | `list` | Quick overview of all accounts and properties |
+| `ga properties` | `list`, `get`, `create`, `update`, `delete` | Manage GA4 properties |
+| `ga custom-dimensions` | `list`, `get`, `create`, `update`, `archive` | Manage custom dimensions |
+| `ga custom-metrics` | `list`, `get`, `create`, `update`, `archive` | Manage custom metrics |
+| `ga data-streams` | `list`, `get`, `create`, `update`, `delete` | Manage data streams |
+| `ga key-events` | `list`, `get`, `create`, `update`, `delete` | Manage key events (conversions) |
+| `ga reports` | `run`, `pivot`, `check-compatibility`, `metadata`, `realtime`, `build` | Run and build reports |
+| `ga upgrade` | `--check`, `--force` | Check for and install updates |
+| `ga completions` | `bash`, `zsh`, `fish` | Generate shell completion scripts |
+
+Use `ga <command> --help` for detailed usage of any command, or `ga --describe` for the full CLI schema as JSON.
+
+### Output formats
+
+All read commands support `--output` (`-o`) to control output format:
+
+```bash
+ga accounts list --output json      # JSON output
+ga accounts list --output table     # Table output (default)
+ga accounts list --output compact   # Minimal ID + name output
+```
+
+## Global Options
+
+```
+--help, -h      Show help
+--version, -v   Show version
+--quiet, -q     Suppress non-essential output
+--no-color      Disable colored output
+--describe      Show full CLI schema as JSON (for agents and tooling)
+```
+
+## Shell Completions
+
+```bash
+ga completions bash > ~/.bash_completion.d/ga
+ga completions zsh > ~/.zsh/completions/_ga
+ga completions fish > ~/.config/fish/completions/ga.fish
+```
+
+## Environment Variables
+
+| Variable | Description |
+|----------|-------------|
+| `GA_CLI_SERVICE_ACCOUNT` | Path to service account key file |
+| `GOOGLE_APPLICATION_CREDENTIALS` | Standard GCP credential path (fallback) |
+| `GA_CLI_CONFIG_DIR` | Override config directory |
+| `GA_CLI_CLIENT_ID` | OAuth client ID (alternative to client_secret.json) |
+| `GA_CLI_CLIENT_SECRET` | OAuth client secret (alternative to client_secret.json) |
+| `NO_COLOR` | Disable colored output |
+
+## CI/CD Integration
+
+```yaml
+jobs:
+  ga-report:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Install GA CLI
+        run: pip install google-analytics-cli
+
+      - name: Export daily report
+        run: |
+          echo '${{ secrets.GA_SERVICE_ACCOUNT_KEY }}' > /tmp/sa-key.json
+          ga auth login --service-account /tmp/sa-key.json
+          ga reports run -p ${{ vars.GA_PROPERTY_ID }} \
+            --metrics sessions,users --dimensions date \
+            --start-date 7daysAgo -o json > report.json
+          rm /tmp/sa-key.json
+```
+
+## Privacy
+
+GA CLI stores authentication credentials locally on your machine. No data is sent to any third party — all communication is directly between your machine and Google's APIs.
+
+## Development
+
+```bash
+# Install with dev dependencies
+uv sync
+
+# Run the CLI
+uv run ga --help
+
+# Run tests
+uv run pytest
+
+# Lint
+uv run ruff check src/ tests/
+```
+
+## License
+
+MIT

google_analytics_cli-0.1.0rc1.dist-info/RECORD

@@ -0,0 +1,49 @@
+ga_cli/__init__.py,sha256=u1fUfOShfVMGpKVw01qh843uLrdZ6cArcFt-6I99WK0,227
+ga_cli/main.py,sha256=uksuGR7J3L5nSbLeoztM4Sij5efMJ5hIHq0JI477T70,4425
+ga_cli/api/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+ga_cli/api/client.py,sha256=GM53azK0cT0a_T9AYGmJfQZdCPanlXTnLXhKXUfLkWA,4375
+ga_cli/auth/__init__.py,sha256=PItt3BDK4o4wDLyUllWt1Q5IjYaz3l_mTywj4w7YxII,764
+ga_cli/auth/credentials.py,sha256=gja3dm060CZBeNyS5W8CMgMbiW_8eZjHUHnjUqwCw-Y,3512
+ga_cli/auth/oauth.py,sha256=KMKQmuFsvNFnTVFHIcGqsjBnKMaS-yDd6fwvrpc9m7g,10086
+ga_cli/auth/service_account.py,sha256=k1UaAwi-8OtKewsdeAvrhFVhEM6NAeBAn5jELuVMW7A,4689
+ga_cli/commands/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+ga_cli/commands/access_bindings.py,sha256=fNUJFFA9-Xr83sPAPy38PnwZPBJu6pskQL4DoHzseIg,8600
+ga_cli/commands/access_reports.py,sha256=Rdqfp3LE9ar6mpGXPz8ogIwLYbrnZGhLKkeuJAEhPVI,6846
+ga_cli/commands/account_summaries.py,sha256=TWdzx55X3m_c6Ji_yCw3JfTYqLKOYnZnLe0qjp2RXH8,2263
+ga_cli/commands/accounts.py,sha256=BOIMbusC4bP5ozU-QC3yt2dYyQ-vLoY_kQQvW_M2-3Q,9977
+ga_cli/commands/agent_cmd.py,sha256=aHBjeOu78xGfLlTzg0D6UpCcvz-v948ONQAV5IuYUVw,34971
+ga_cli/commands/annotations.py,sha256=5syML-sRiaeVCJXqR6ftfniyk20oySe4df282owJziY,8706
+ga_cli/commands/audiences.py,sha256=RKNZB4RkHnpmI-efBi3g54Co_Ez2bR8MhDijRIxdSCs,7121
+ga_cli/commands/auth_cmd.py,sha256=wQUOtieylMUGLHd7PAaxUtX4EmVYNMHbAqDsJPRfIgI,6554
+ga_cli/commands/bigquery_links.py,sha256=sBmEhA1W2HWWK-KcH6wirtYA9TbAYoChEqWNK8cq04I,10987
+ga_cli/commands/calculated_metrics.py,sha256=BvDZajhTjOZ4u9nZu2oYI8pM7wksUb1_VLQwTxEC1Js,10046
+ga_cli/commands/channel_groups.py,sha256=3CTzttnQuyZiJ-PPNnuHlbyfNo8RR9xDh7vMavk8ijk,7259
+ga_cli/commands/completions_cmd.py,sha256=01aBw0jNsR5mD3USQOACwDBreh2V3xaJN3wGxmeVGYw,1372
+ga_cli/commands/config_cmd.py,sha256=knYM0DxbPiq-IqqspQzVVgOtPKxi5ljjoXOZCb-u0mw,3061
+ga_cli/commands/custom_dimensions.py,sha256=0MAIxq6kEvlrQiGRJFZn5Y_SI9-wFTjZg_cy5UQ41rE,8997
+ga_cli/commands/custom_metrics.py,sha256=i9p0LH2L4ES2kJkrxOihY4NLVw3hCLDr5xRemMnw3TE,9963
+ga_cli/commands/data_retention.py,sha256=3dE1VbnFJ_KZazDeVZzy95WRQ2q8xLLg_Atr1fkclqs,4871
+ga_cli/commands/data_streams.py,sha256=s8vyWz_znMWvlJ7jihXS4bhArwLaAmfr1JxylbB8_ns,8887
+ga_cli/commands/event_create_rules.py,sha256=SfwVTq5cnSIZ4WvIBnUUB2p54VbjEy_lnN-KohlAQ_8,8133
+ga_cli/commands/event_edit_rules.py,sha256=16celmbTD1LgYUrsjv1Eks9TRykIvas3je197nNByrQ,9443
+ga_cli/commands/firebase_links.py,sha256=DKkwqdzKEQhc1nzscBNFRtHKLZhvnBXYCBXrn04SSyQ,4426
+ga_cli/commands/google_ads_links.py,sha256=jSoLy26A0NX_3M0WPMtVCtk8CKLXywqBj-XS54eBqVA,7079
+ga_cli/commands/key_events.py,sha256=4xRYXl8UU_rZJwhK4IESjFBirpNaMRsXIwpwriyfBP8,8571
+ga_cli/commands/mp_secrets.py,sha256=fbK9F3jr8N68nSyAtKRT3a15n7sTfFH8hmBTl8337v8,8634
+ga_cli/commands/properties.py,sha256=AAp3Aa7g7ZZt2vecG3RxBzi8NTRO6bIaIUmV-Pzrfjo,11584
+ga_cli/commands/property_settings.py,sha256=Qlz2a-1ufPUwbN7CfY3XepW6mCv4UtMUj1aaMgSA9l8,10265
+ga_cli/commands/reports.py,sha256=2Gw5Nd9fz0DKw8TUfgLThqzEz3swCKsbaUnf1oM2MYI,25960
+ga_cli/commands/upgrade_cmd.py,sha256=LhRZ4cjXqAz9xx1CDYYgWeSp_xhkLiHdpOV3XflcahA,4726
+ga_cli/config/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+ga_cli/config/constants.py,sha256=Oo_gg1R8WVNColi3wFLCKQkVH_DiCPL_07HQFt9HgL4,1651
+ga_cli/config/store.py,sha256=fqB3AV3DcAz94sq2qXNEI8d6MBfXA945QFaYq25NraU,3294
+ga_cli/utils/__init__.py,sha256=AWd3N-hbTXsY9sg_LYchPFlgfouq2KlEgU-ecL5cG34,908
+ga_cli/utils/describe.py,sha256=QtCXB4Nm3DKb9BBxDEQbHv6UbDL3bo7WRYRucIEWaXs,3999
+ga_cli/utils/dry_run.py,sha256=DD4Id-0Y6eSKC7KiknAtXDxKhyxQRuSekjgNOQF3EJA,1149
+ga_cli/utils/errors.py,sha256=l0Iwjmj1QqzLU032QAiVUnIbfntkxoIAZqyQCfgACCE,4465
+ga_cli/utils/output.py,sha256=0ihWQi7-kGSkNb-0OTFv_12ZmqVUjpZQLEGjvNrxUeE,6092
+ga_cli/utils/pagination.py,sha256=w6_To6luCR54M04Uk_WFFydvProG2yGxN-CzkzSk9c4,2380
+google_analytics_cli-0.1.0rc1.dist-info/METADATA,sha256=8EgBv0ux-hl2sO9o4Ci8nvtTUUM0XtME3ydVjhsDAZE,8193
+google_analytics_cli-0.1.0rc1.dist-info/WHEEL,sha256=QccIxa26bgl1E6uMy58deGWi-0aeIkkangHcxk2kWfw,87
+google_analytics_cli-0.1.0rc1.dist-info/entry_points.txt,sha256=J1Jvi1IZo4YujxqhyipvHz4NAepNhxZo7g_WyQIIOz0,39
+google_analytics_cli-0.1.0rc1.dist-info/RECORD,,

google_analytics_cli-0.1.0rc1.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.29.0
+Root-Is-Purelib: true
+Tag: py3-none-any

google_analytics_cli-0.1.0rc1.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+ga = ga_cli.main:run