Skip to content

Commit

Permalink
Rename daft cli and bump up version (#48)
Browse files Browse the repository at this point in the history
* Rename daft-launcher to daft-cli, bump release version
  • Loading branch information
jessie-young authored Jan 28, 2025
1 parent 7e73181 commit cc44075
Show file tree
Hide file tree
Showing 5 changed files with 12 additions and 12 deletions.
2 changes: 1 addition & 1 deletion Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions Cargo.toml
Original file line number Diff line number Diff line change
@@ -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]
Expand Down
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,21 +10,21 @@
[![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

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)
Expand All @@ -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

Expand Down Expand Up @@ -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)
Expand Down
2 changes: 1 addition & 1 deletion docs/byoc/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -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"]
Expand Down

0 comments on commit cc44075

Please sign in to comment.