Skip to main content

Steve CLI

A simple CLI tool to run jobs from jobs.yaml with proper environment setup. Perfect for local development and testing of automation kernel jobs.

Installation

Install from local development

cd /home/frank/Projects/7frank/tilt-ts-4/apps/example-hehnke/packages/steve-cli
uv venv
uv pip install -e .

Install from GitHub

uv add steve-cli

OR

uv add git+https://github.com/your-org/tilt-ts-4.git#subdirectory=apps/example-hehnke/packages/steve-cli

Usage

Run a job

steve extract-data
steve transform-data
steve validate-data

This will:

  1. Look for jobs.yaml in the current directory
  2. Find the specified job by name
  3. Set all environment variables from the job's env section
  4. Execute the job's command with the proper environment

List available jobs

steve ls

Shows all jobs in jobs.yaml with their commands, schedules, dependencies, and environment variables.

Get help

steve help
steve --help

Use custom jobs file

steve -f path/to/custom.yaml extract-data
steve ls -f path/to/custom.yaml

Example

Given a jobs.yaml file:

jobs:
  - name: extract-data
    cron: "0 2 * * *"
    command: ["uv", "run", "src/extract.py"]
    env:
      SOURCE_URL: "https://jsonplaceholder.typicode.com/users"
      OUTPUT_PATH: "/data/raw/extracted_data.parquet"

  - name: transform-data
    dependsOn: ["extract-data"]
    command: ["uv", "run", "src/transform.py"]
    env:
      INPUT_PATH: "/data/raw/extracted_data.parquet"
      OUTPUT_PATH: "/data/processed"

Running steve extract-data will:

  1. Set SOURCE_URL=https://jsonplaceholder.typicode.com/users
  2. Set OUTPUT_PATH=/data/raw/extracted_data.parquet
  3. Execute: uv run src/extract.py

Features

  • ✅ Simple: Just steve <job-name> to run any job
  • ✅ Environment: Automatically sets environment variables from jobs.yaml
  • ✅ Discovery: Auto-finds jobs.yaml in current directory
  • ✅ Listing: See all available jobs with steve ls
  • ✅ Flexible: Supports custom jobs file paths
  • ✅ Colorful: Nice colored output for better readability
  • ✅ Error handling: Clear error messages for missing jobs or files

File Metadata Extraction

Steve automatically extracts metadata from files read or written via MetadataRegistry. The extractor is chosen by file extension — no configuration needed.

Extension Extractor Requires
.parquet, .pq ParquetExtractor pip install steve-cli[polars]
.csv, .tsv, .txt CsvExtractor stdlib only
.json, .jsonl, .ndjson JsonExtractor stdlib only
.xlsx, .xls, .xlsm ExcelExtractor pip install steve-cli[excel]
anything else GenericExtractor stdlib only

Adding a custom extractor

Implement MetadataExtractorPort, declare which extensions it handles, and register it once at startup:

from steve_cli.storage.metadata.port import MetadataExtractorPort, FileMetadata, ColumnMetadata
from steve_cli.storage.metadata.registry import MetadataRegistry

class AvroExtractor(MetadataExtractorPort):
    extensions = (".avro",)

    def extract(self, data: bytes, path: str) -> FileMetadata:
        import fastavro, io
        reader = fastavro.reader(io.BytesIO(data))
        schema = reader.writer_schema
        columns = [
            ColumnMetadata(name=f["name"], type=str(f["type"]))
            for f in schema.get("fields", [])
        ]
        records = list(reader)
        return FileMetadata(
            format="avro",
            size_bytes=len(data),
            rows=len(records),
            columns=columns,
        )

MetadataRegistry.register("avro", AvroExtractor)

After registration, MetadataRegistry.extract(data, "output.avro") picks AvroExtractor automatically. You can also force a specific extractor for any file via the env var:

METADATA_EXTRACTOR=avro steve jobs run my-job

Why Steve?

Named after Steve Jobs - because it helps you run jobs locally! 😄

Requirements

  • Python 3.8+
  • click >= 8.0.0
  • pyyaml >= 6.0

Development

# Install in development mode
uv pip install -e .

# Run tests (when added)
pytest

# Format code
black steve_cli/
isort steve_cli/

use cli

source .venv/bin/activate steve

uv build uv publish

Metadata

Release files for steve-cli 0.3.20

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for steve-cli 0.3.20
File Size Uploaded
steve_cli-0.3.20.tar.gz 27.0 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for steve-cli 0.3.20
File Interpreter ABI Platform
steve_cli-0.3.20-py3-none-any.whl Python 3 none any Details

Total release size: 61.5 kB

Release files / steve_cli-0.3.20.tar.gz

Download URL steve_cli-0.3.20.tar.gz
Size 27.0 kB
Tags Source
SHA-256 checksum
How to use checksums
036fbbea10388a830072d6874fe83b802b2be127b8901a59bf0a4ccb994f0b94
BLAKE2b-256 checksum
How to use checksums
9f9d7a7a90cbc7a820be73cb5112b6d2bbeece42ed797d173ebf0b6d4ad749cb
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.11.21 {"installer":{"name":"uv","version":"0.11.21","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"25.04","id":"plucky","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

Release files / steve_cli-0.3.20-py3-none-any.whl

Download URL steve_cli-0.3.20-py3-none-any.whl
Size 34.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
aa911dfee5e7e8a1e7893b3c8969b30fcd7dcd71dbb757c9be3d1797af877aff
BLAKE2b-256 checksum
How to use checksums
bde2a95757ee2ef505d9589286e96095cd58e99a18074e623a6d6e7e48a160e3
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.11.21 {"installer":{"name":"uv","version":"0.11.21","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"25.04","id":"plucky","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

Release history Release notifications | RSS feed

1.1.6

2 release files

1.1.5

2 release files

1.1.4

2 release files

1.1.3

2 release files

1.1.2

2 release files

1.1.1

2 release files

1.0.3

2 release files

1.0.2

2 release files

1.0.1

2 release files

0.5.6

2 release files

0.5.5

2 release files

0.5.4

2 release files

0.5.3

2 release files

0.5.2

2 release files

0.4.1

2 release files

This release

0.3.20 This release

2 release files

0.3.19

2 release files

0.3.18

2 release files

0.3.17

2 release files

0.3.16

2 release files

0.3.15

2 release files

0.3.14

2 release files

0.3.13

2 release files

0.3.11

2 release files

0.3.9

2 release files

0.3.8

2 release files

0.3.7

2 release files

0.3.6

2 release files

0.3.5

2 release files

0.3.2

2 release files

0.3.1

2 release files

0.3.0

2 release files

0.2.0

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page