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.4.1.tar.gz (134.2 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.4.1-py3-none-any.whl (22.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: trainwave_cli-0.4.1.tar.gz
  • Upload date:
  • Size: 134.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.7 {"installer":{"name":"uv","version":"0.11.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.4.1.tar.gz
Algorithm Hash digest
SHA256 aa47e166f29f2570429411cd18a3ed34dd44ee96ebfbe89401389795a6c4f8a2
MD5 6891536c994a6bd6ca16ff5249d5c687
BLAKE2b-256 2547414ea7b91ce58c3912c9699198abb5a1eb24fba71a80411d5deae3e236f0

See more details on using hashes here.

File details

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

File metadata

  • Download URL: trainwave_cli-0.4.1-py3-none-any.whl
  • Upload date:
  • Size: 22.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.7 {"installer":{"name":"uv","version":"0.11.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.4.1-py3-none-any.whl
Algorithm Hash digest
SHA256 cdc369635c976da707f6839deda5609a2b8732605b6ee2b50300f38458feffc5
MD5 21f2d35ca58a2bd0e08612c42808ed10
BLAKE2b-256 b0252626b29f42740dbfab6d2a0049b22bb915660b961b7887d9d685138cdd9a

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