diff --git a/Cargo.lock b/Cargo.lock index e7d1e8c..851f443 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -609,7 +609,7 @@ dependencies = [ [[package]] name = "daft" -version = "0.5.0-alpha0" +version = "0.6.0-alpha0" dependencies = [ "anyhow", "aws-config", diff --git a/Cargo.toml b/Cargo.toml index 98e4e29..d32b827 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,8 +1,8 @@ [package] name = "daft" -version = "0.5.0-alpha0" +version = "0.6.0-alpha0" edition = "2021" -description = "A simple launcher for spinning up and managing Ray clusters for Daft" +description = "A simple CLI for spinning up and managing Ray clusters for Daft" license = "LICENSE" [dependencies] diff --git a/README.md b/README.md index d5f09a2..323008e 100644 --- a/README.md +++ b/README.md @@ -10,9 +10,9 @@ [![Latest](https://img.shields.io/github/v/tag/Eventual-Inc/daft-launcher?label=latest&logo=GitHub)](https://github.com/Eventual-Inc/daft-launcher/tags) [![License](https://img.shields.io/badge/daft_launcher-docs-red.svg)](https://eventual-inc.github.io/daft-launcher) -# Daft Launcher CLI Tool +# Daft CLI Tool -`daft-launcher` is a simple launcher for spinning up and managing Ray clusters for [`daft`](https://github.com/Eventual-Inc/Daft). +`daft-cli` is a simple launcher for spinning up and managing Ray clusters for [`daft`](https://github.com/Eventual-Inc/Daft). ## Goal @@ -20,11 +20,11 @@ Getting started with Daft in a local environment is easy. However, getting started with Daft in a cloud environment is substantially more difficult. So much more difficult, in fact, that users end up spending more time setting up their environment than actually playing with our query engine. -Daft Launcher aims to solve this problem by providing a simple CLI tool to remove all of this unnecessary heavy-lifting. +Daft CLI aims to solve this problem by providing a simple CLI tool to remove all of this unnecessary heavy-lifting. ## Capabilities -What Daft Launcher is capable of: +What Daft CLI is capable of: 1. Spinning up clusters (Provisioned mode only) 2. Listing all available clusters as well as their statuses (Provisioned mode only) 3. Submitting jobs to a cluster (Both Provisioned and BYOC modes) @@ -35,7 +35,7 @@ What Daft Launcher is capable of: ## Operation Modes -Daft Launcher supports two modes of operation: +Daft CLI supports two modes of operation: - **Provisioned**: Automatically provisions and manages Ray clusters in AWS - **BYOC (Bring Your Own Cluster)**: Connects to existing Ray clusters in Kubernetes @@ -145,8 +145,8 @@ uv pip install daft-launcher ### Example Usage -All interactions with Daft Launcher are primarily communicated via a configuration file. -By default, Daft Launcher will look inside your `$CWD` for a file named `.daft.toml`. +All interactions with Daft CLI are primarily communicated via a configuration file. +By default, Daft CLI will look inside your `$CWD` for a file named `.daft.toml`. You can override this behaviour by specifying a custom configuration file. #### Provisioned Mode (AWS) diff --git a/docs/byoc/README.md b/docs/byoc/README.md index 4debdd0..1afa8fa 100644 --- a/docs/byoc/README.md +++ b/docs/byoc/README.md @@ -8,7 +8,7 @@ This directory contains guides for setting up Ray and Daft on various Kubernetes ## Prerequisites -Before using `daft-launcher` in BYOC mode with Kubernetes, you must: +Before using `daft-cli` in BYOC mode with Kubernetes, you must: 1. Have a running Kubernetes cluster (local, cloud-managed, or on-premise) 2. Install and configure Ray on your Kubernetes cluster 3. Install Daft on your cluster diff --git a/pyproject.toml b/pyproject.toml index 89892d3..547dd2e 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,5 +1,5 @@ [project] -name = "daft-launcher" +name = "daft-cli" dependencies = ["ray[default]", "maturin>=1.0,<2.0"] requires-python = ">=3.9" dynamic = ["version"]