arize-ax-cli 0.0.0__tar.gz

arize_ax_cli-0.0.0/.gitignore

@@ -0,0 +1,84 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+test_data/
+
+# Virtual environments
+venv/
+env/
+ENV/
+env.bak/
+venv.bak/
+
+# IDEs
+.vscode/
+.idea/
+*.swp
+*.swo
+*~
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# OS
+.DS_Store
+Thumbs.db
+
+# Project specific
+*.log
+.env

arize_ax_cli-0.0.0/LICENSE

@@ -0,0 +1,69 @@
+Apache License
+Version 2.0, January 2004
+http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+"License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files.
+
+"Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below).
+
+"Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof.
+
+"Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions:
+
+(a) You must give any other recipients of the Work or Derivative Works a copy of this License; and
+
+(b) You must cause any modified files to carry prominent notices stating that You changed the files; and
+
+(c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and
+
+(d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License.
+
+You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+Copyright 2026 Arize AI, Inc.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

arize_ax_cli-0.0.0/PKG-INFO

@@ -0,0 +1,472 @@
+Metadata-Version: 2.4
+Name: arize-ax-cli
+Version: 0.0.0
+Summary: Official Arize CLI tool for managing datasets, experiments, and more
+Project-URL: Homepage, https://arize.com
+Project-URL: Documentation, https://docs.arize.com/cli
+Project-URL: Repository, https://github.com/Arize-ai/ax-cli
+Project-URL: Bug Tracker, https://github.com/Arize-ai/ax-cli/issues
+Author-email: Arize AI <support@arize.com>
+License: Apache-2.0
+License-File: LICENSE
+Keywords: arize,cli,llm,machine-learning,mlops,observability
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.12
+Requires-Dist: arize<9,>=8.0.0b0
+Requires-Dist: pydantic<3,>=2.0.0
+Requires-Dist: questionary<3,>=2.0.0
+Requires-Dist: rich<14,>=13.0.0
+Requires-Dist: shellingham<2,>=1.5.0
+Requires-Dist: tomli-w<2,>=1.0.0
+Requires-Dist: typer<1,>=0.12.0
+Provides-Extra: dev
+Requires-Dist: mypy==1.19.1; extra == 'dev'
+Requires-Dist: pandas-stubs>=2.2.0; extra == 'dev'
+Requires-Dist: pytest-cov==6.0.0; extra == 'dev'
+Requires-Dist: pytest==8.4.2; extra == 'dev'
+Requires-Dist: ruff==0.14.9; extra == 'dev'
+Requires-Dist: taskipy<2,>=1.14.1; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# Arize CLI (`ax`)
+
+Official command-line interface for Arize AI. Manage datasets, experiments, and more from your terminal.
+
+## Features
+
+- **Dataset Management**: Create, list, and manage datasets with support for CSV, JSON, JSONL, and Parquet formats
+- **Experiment Management**: Run and track experiments with your datasets
+- **Profile Management**: Multiple configuration profiles for different environments (dev, staging, prod)
+- **Rich Output**: Beautiful table formatting, JSON, CSV, and Parquet export options
+- **Interactive**: Confirmation prompts, progress bars, and helpful error messages
+- **Type-Safe**: Built with modern Python 3.12+ and Typer for excellent IDE support
+
+## Requirements
+
+- Python 3.12 or higher
+- Arize API key ([get one here](https://app.arize.com/settings/api-keys))
+
+## Installation
+
+```bash
+pip install arize-ax-cli
+```
+
+## Quick Start
+
+### 1. Initialize Configuration
+
+```bash
+ax config init
+```
+
+This will interactively prompt you for:
+
+- API Key
+- Default Space ID (optional)
+- Region (us-central-1a, eu-west-1a, ca-central-1a, us-east-1b)
+- Output preferences
+
+### 2. List Datasets
+
+```bash
+ax datasets list
+```
+
+### 3. Create a Dataset
+
+```bash
+ax datasets create --name "My Dataset" --file data.csv
+```
+
+### 4. View Help
+
+```bash
+ax --help
+ax datasets --help
+ax config --help
+```
+
+## Commands
+
+### Global Options
+
+Available on all commands:
+
+```bash
+--api-key TEXT         Override API key
+--region TEXT          Override region
+--profile TEXT         Use specific profile
+--no-color            Disable colored output
+--verbose, -v         Verbose output
+--quiet, -q           Suppress non-essential output
+--help, -h            Show help
+--version             Show version
+```
+
+### Command-Level Options
+
+These options are available on specific commands and are passed after the subcommand:
+
+#### Output Option
+
+Available on list and export commands:
+
+```bash
+-o, --output TEXT      Output format (table, json, csv, parquet) or file path
+```
+
+The `-o` option intelligently handles both formats and file paths:
+
+- Format names (`table`, `json`, `csv`, `parquet`) output to stdout
+- File paths (`data.json`, `output.csv`) save to file with auto-detected format
+
+#### Space ID Option
+
+Available on dataset commands:
+
+```bash
+--space-id TEXT        Space ID (env: ARIZE_SPACE_ID, config: defaults.space_id)
+```
+
+Precedence: command flag > environment variable > config file
+
+### Configuration Management
+
+```bash
+# Initialize configuration
+ax config init
+ax config init --profile dev
+
+# Show configuration
+ax config show
+ax config show --profile prod
+
+# Set a value
+ax config set auth.api_key "new-key"
+ax config set defaults.region eu-west-1a
+
+# Get a value
+ax config get auth.api_key
+
+# Clear cache
+ax config clear-cache
+
+# Profile management
+ax config profile list
+ax config profile use dev
+ax config profile show
+ax config profile delete old-profile
+```
+
+### Dataset Commands
+
+```bash
+# List datasets
+ax datasets list
+ax datasets list --limit 100
+ax datasets list --space-id my-space --limit 100
+
+# List with different output formats (to stdout)
+ax datasets list -o json
+ax datasets list -o csv
+ax datasets list -o table
+
+# Save to file (format auto-detected from extension)
+ax datasets list -o datasets.json
+ax datasets list -o datasets.csv
+ax datasets list -o datasets.parquet
+
+# Combine options naturally
+ax datasets list --space-id my-space -o json
+ax datasets list --space-id my-space -o datasets.csv
+
+# Create dataset from file
+ax datasets create --name "Training Data" --file data.csv
+ax datasets create --name "Test Data" --file data.json --space-id my-space
+
+# Get dataset details
+ax datasets get --id dataset-123
+
+# Delete dataset (with confirmation)
+ax datasets delete --id dataset-123
+ax datasets delete --id dataset-123 --force
+
+# List dataset examples
+ax datasets examples --id dataset-123 --limit 500
+ax datasets examples --id dataset-123 -o json
+ax datasets examples --id dataset-123 -o examples.csv
+```
+
+### Experiment Commands
+
+```bash
+# List experiments
+ax experiments list
+ax experiments list --dataset-id dataset-123
+
+# List with different output formats
+ax experiments list -o json
+ax experiments list -o experiments.csv
+
+# Create experiment
+ax experiments create --name "Experiment 1" --dataset-id dataset-123
+
+# Get experiment details
+ax experiments get --id exp-123
+
+# Delete experiment
+ax experiments delete --id exp-123
+
+# Run experiment (coming soon)
+ax experiments run --id exp-123 --task task.py
+ax experiments run --id exp-123 --task task.py --async
+
+# List experiment runs (coming soon)
+ax experiments runs --id exp-123
+```
+
+## Configuration
+
+### Configuration File Locations
+
+- Default profile: `~/.arize/config.toml`
+- Named profiles: `~/.arize/profiles/<profile-name>.toml`
+- Active profile marker: `~/.arize/.active_profile`
+
+### Configuration Structure
+
+```toml
+[profile]
+name = "default"
+
+[auth]
+api_key = "your-api-key"
+
+[defaults]
+space_id = "default-space-id"
+region = "us-central-1a"
+
+[output]
+format = "table"
+color = true
+
+[cache]
+enabled = true
+directory = "~/.arize/cache"
+```
+
+### Configuration Precedence
+
+Settings are resolved in this order (highest to lowest):
+
+1. Command-line flags (`--api-key`, `--region`, etc.)
+2. Environment variables (`ARIZE_API_KEY`, `ARIZE_REGION`, `ARIZE_PROFILE`)
+3. Active profile config file
+4. Default profile config file
+5. SDK defaults
+
+### Environment Variables
+
+```bash
+export ARIZE_API_KEY="your-api-key"
+export ARIZE_REGION="us-central-1a"
+export ARIZE_SPACE_ID="your-space-id"
+export ARIZE_PROFILE="dev"
+```
+
+## Examples
+
+### Working with Multiple Profiles
+
+```bash
+# Create profiles for different environments
+ax config init --profile dev
+ax config init --profile staging
+ax config init --profile prod
+
+# Switch between profiles
+ax config profile use staging
+
+# Or use --profile flag
+ax datasets list --profile prod
+
+# Or use environment variable
+export ARIZE_PROFILE=dev
+ax datasets list
+```
+
+### Output Options
+
+The `-o` / `--output` option accepts either a format name or a file path:
+
+```bash
+# Output format to stdout
+ax datasets list -o json        # JSON to stdout
+ax datasets list -o csv         # CSV to stdout
+ax datasets list -o table       # Pretty table to stdout (default)
+ax datasets list -o parquet     # Parquet to stdout (binary)
+
+# Save to file (format auto-detected from extension)
+ax datasets list -o datasets.json     # JSON file
+ax datasets list -o datasets.csv      # CSV file
+ax datasets list -o datasets.parquet  # Parquet file
+
+# Examples with dataset examples
+ax datasets examples --id dataset-123 -o json
+ax datasets examples --id dataset-123 -o examples.csv
+ax datasets examples --id dataset-123 -o examples.parquet
+
+# Output format can also be set in config profile
+ax --profile json datasets list  # Uses json format from profile
+```
+
+The output option respects this precedence:
+
+1. `-o` / `--output` flag (highest priority)
+2. Config file `output.format` setting
+3. Default (`table`)
+
+````bash
+
+### Creating Datasets from Different Formats
+
+```bash
+# From CSV
+ax datasets create --name "CSV Data" --file data.csv
+
+# From JSON
+ax datasets create --name "JSON Data" --file data.json
+
+# From JSON Lines
+ax datasets create --name "JSONL Data" --file data.jsonl
+
+# From Parquet
+ax datasets create --name "Parquet Data" --file data.parquet
+````
+
+### Scripting and Automation
+
+```bash
+#!/bin/bash
+
+# Set environment variables
+export ARIZE_API_KEY="your-key"
+export ARIZE_SPACE_ID="your-space"
+
+# Create dataset
+DATASET_ID=$(ax datasets create --name "Auto Dataset" --file data.csv -o json | jq -r '.id')
+
+# Create experiment
+EXP_ID=$(ax experiments create --name "Auto Exp" --dataset-id "$DATASET_ID" -o json | jq -r '.id')
+
+echo "Created experiment $EXP_ID for dataset $DATASET_ID"
+```
+
+## Shell Completion
+
+Typer provides automatic shell completion. To install:
+
+### Bash
+
+```bash
+ax --install-completion bash
+source ~/.bashrc
+```
+
+### Zsh
+
+```bash
+ax --install-completion zsh
+source ~/.zshrc
+```
+
+### Fish
+
+```bash
+ax --install-completion fish
+```
+
+## Development
+
+### Setup Development Environment
+
+```bash
+git clone https://github.com/Arize-ai/client_python.git
+cd client_python/ax-cli
+
+# Create virtual environment
+python -m venv venv
+source venv/bin/activate  # On Windows: venv\Scripts\activate
+
+# Install in editable mode with dev dependencies
+pip install -e ".[dev]"
+```
+
+### Running Tests
+
+```bash
+pytest
+pytest --cov=ax --cov-report=html
+```
+
+### Code Quality
+
+```bash
+# Format and lint
+ruff check src/
+ruff format src/
+
+# Type checking
+mypy src/
+```
+
+## Troubleshooting
+
+### Authentication Errors
+
+If you see "API key not found" or authentication errors:
+
+1. Verify your API key is correct
+2. Check configuration: `ax config show`
+3. Try re-initializing: `ax config init --force`
+4. Verify key at: https://app.arize.com/settings/api-keys
+
+### Import Errors
+
+If you get import errors after installation:
+
+```bash
+pip install --upgrade arize-ax-cli
+# Or if installed from source:
+pip install -e . --force-reinstall
+```
+
+### Configuration Issues
+
+To reset configuration:
+
+```bash
+rm -rf ~/.arize
+ax config init
+```
+
+## Support
+
+- Documentation: https://docs.arize.com/cli
+- GitHub Issues: https://github.com/Arize-ai/client_python/issues
+- Community: https://arize.com/community
+
+## License
+
+Apache License 2.0 - see LICENSE file for details.
+
+## Contributing
+
+Contributions are welcome! Please see CONTRIBUTING.md for guidelines.