Skip to main content

Trainwave CLI - A command-line interface for managing Trainwave resources

Project description

Trainwave CLI

A command-line interface for interacting with Trainwave's machine learning platform. This CLI tool provides functionality for managing training jobs, handling authentication, managing secrets, and configuring your Trainwave environment.

Features

  • Job Management: Create, monitor, and manage training jobs
  • Authentication: Secure authentication with Trainwave's platform
  • Secrets Management: Handle sensitive information for your jobs
  • Configuration: Set up and manage your Trainwave environment

Installation

Using pip

pip install trainwave-cli

From Source

  1. Clone the repository
  2. Install using uv:
uv sync

Usage

The CLI provides several main commands:

wave jobs     # Manage training jobs
wave auth     # Authenticate with Trainwave
wave config   # Configure your Trainwave environment
wave secrets  # Manage job secrets

For detailed help on any command:

wave --help
wave <command> --help

Development

This project uses uv for dependency management and packaging. Here's how to set up your development environment:

Prerequisites

  • Python 3.10 or higher
  • uv
  • Make (for development commands)

Setting Up Development Environment

  1. Clone the repository
  2. Install development dependencies:
make install-dev

Development Commands

The project includes several Make targets to help with development:

  • make install: Install production dependencies
  • make install-dev: Install development dependencies
  • make clean: Remove temporary files and build artifacts
  • make ruff: Run Ruff linter
  • make format: Format code using Black and Ruff
  • make check: Run all code quality checks
  • make test: Run the test suite
  • make help: Show available make commands

Code Style

The project uses:

  • Ruff for linting
  • Black for code formatting
  • Type hints are required for all functions

Running Tests

make test

Or directly with pytest:

pytest tests/

Project Structure

trainwave-cli/
├── trainwave_cli/     # Main package directory
├── tests/            # Test files
├── example/          # Example configurations and usage
├── pyproject.toml    # Project metadata and dependencies
└── Makefile         # Development automation

Contributing

  1. Fork the repository
  2. Create a feature branch
  3. Make your changes
  4. Run tests and linting: make check
  5. Submit a pull request

License

[License information here]

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

trainwave_cli-0.3.0.tar.gz (128.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

trainwave_cli-0.3.0-py3-none-any.whl (19.9 kB view details)

Uploaded Python 3

File details

Details for the file trainwave_cli-0.3.0.tar.gz.

File metadata

  • Download URL: trainwave_cli-0.3.0.tar.gz
  • Upload date:
  • Size: 128.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.10.7 {"installer":{"name":"uv","version":"0.10.7","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Debian GNU/Linux","version":"13","id":"trixie","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for trainwave_cli-0.3.0.tar.gz
Algorithm Hash digest
SHA256 b69c47ffb3f189b925c6a13d97139ee0d92911505706c528e120e43b0570e1c7
MD5 81bb28ee060357482a1b98af86233d66
BLAKE2b-256 43e910739df4df90c9db120d4ce389beb8f70880d37949a93e53d1597f9852ae

See more details on using hashes here.

File details

Details for the file trainwave_cli-0.3.0-py3-none-any.whl.

File metadata

  • Download URL: trainwave_cli-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 19.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.10.7 {"installer":{"name":"uv","version":"0.10.7","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Debian GNU/Linux","version":"13","id":"trixie","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for trainwave_cli-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 325685aa6d83babc5466ebb7886cd79e025a843f837437adf31ce9bf333cceaf
MD5 ac18bab2e63edcad1ffb528ff4123010
BLAKE2b-256 5a4a25aebd56502b533c33050093f427612c69cd567432f0b18b2ffeb50d4c92

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page