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 Poetry:
poetry install

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 Poetry for dependency management and packaging. Here's how to set up your development environment:

Prerequisites

  • Python 3.10 or higher
  • Poetry
  • 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.2.5.tar.gz (14.0 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.2.5-py3-none-any.whl (17.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: trainwave_cli-0.2.5.tar.gz
  • Upload date:
  • Size: 14.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.1 CPython/3.10.16 Linux/5.15.0-1070-aws

File hashes

Hashes for trainwave_cli-0.2.5.tar.gz
Algorithm Hash digest
SHA256 351404f08ceff2b3c22f3211042a985092d7ee651766b923e48716f133d76e04
MD5 f8b035c439bf9223d663c9a7b9e796db
BLAKE2b-256 208e9d4422783259cb5a76f09ec897c701c3f65a569b50aaf2ef2944b430708d

See more details on using hashes here.

File details

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

File metadata

  • Download URL: trainwave_cli-0.2.5-py3-none-any.whl
  • Upload date:
  • Size: 17.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.1 CPython/3.10.16 Linux/5.15.0-1070-aws

File hashes

Hashes for trainwave_cli-0.2.5-py3-none-any.whl
Algorithm Hash digest
SHA256 80773c1cc24c11e0ad089d08d70aecc5908334e933e1d20d1c1d3b55358da27d
MD5 03e6f9ed1b0674bf5c700e7776cb65d8
BLAKE2b-256 b0d1afd3f3138092440d088f3ca147d17a44e966faff133059507d4c2559e227

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