Skip to main content

Unified toolkit for Quilt workflows.

Project description

quiltx

Quilt extension toolkit with shared utilities for working with Quilt catalogs.

Installation

# No installation needed! Use uvx to run directly:
uvx quiltx --list

Usage

Run tools directly with uvx (recommended):

# List available tools
uvx quiltx --list

# Configure a Quilt catalog
uvx quiltx config https://open.quiltdata.com

# Show current catalog configuration
uvx quiltx config

# Get help
uvx quiltx --help
uvx quiltx <tool> --help

Or if installed with pipx:

quiltx --list
quiltx config https://open.quiltdata.com
quiltx stack
quiltx logs --minutes 30 --filter "ERROR"

Built-in Tools

  • config: Configure and display Quilt catalog settings using the configured_catalog API
  • stack: Discover the Quilt CloudFormation stack and cache log group metadata in stack.json
  • logs: Display CloudWatch Logs for the configured catalog using stack.json

Development

Setup

# Clone the repository
git clone https://github.com/ernest/quiltx.git
cd quiltx

# Install uv if you don't have it
curl -LsSf https://astral.sh/uv/install.sh | sh

# Install in development mode
pip install -e ".[dev]"

Running Tests

# Using poe (recommended)
./poe test

# Or directly with pytest
pytest tests

Project Structure

quiltx/
├─ quiltx/              # Main package
│  ├─ cli.py           # Unified CLI with auto-discovery
│  ├─ tools/           # Built-in tools (auto-discovered)
│  │  └─ config.py
│  └─ __init__.py      # Shared utilities (configured_catalog)
├─ tests/              # Test suite
├─ pyproject.toml      # Package configuration
└─ poe                 # Task runner script

Adding New Tools

Tools are automatically discovered from the quiltx/tools/ directory. To add a new tool:

  1. Create a new file in quiltx/tools/ (e.g., mytool.py)
  2. Implement a main(argv) function that returns an exit code
  3. The tool will be automatically available via quiltx mytool
  4. Add tests in tests/

Example tool structure:

"""My new tool."""
import argparse

def build_parser() -> argparse.ArgumentParser:
    parser = argparse.ArgumentParser(description="My tool description")
    # Add arguments
    return parser

def main(argv: list[str] | None = None) -> int:
    parser = build_parser()
    args = parser.parse_args(argv)
    # Tool implementation
    return 0

License

MIT License - see LICENSE file for details

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

quiltx-0.2.0.tar.gz (138.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

quiltx-0.2.0-py3-none-any.whl (32.6 kB view details)

Uploaded Python 3

File details

Details for the file quiltx-0.2.0.tar.gz.

File metadata

  • Download URL: quiltx-0.2.0.tar.gz
  • Upload date:
  • Size: 138.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for quiltx-0.2.0.tar.gz
Algorithm Hash digest
SHA256 55bb01bd075edfac3e657d8a40a1be167ef6da7d4b1c9e79b4a199c469d96f7d
MD5 7c63b5486cc773a8512746646ff0f391
BLAKE2b-256 15305dc191ffaf46b6fcfd0c6c20f9f9c4218d42f4a10d78a9ed1938f808404b

See more details on using hashes here.

Provenance

The following attestation bundles were made for quiltx-0.2.0.tar.gz:

Publisher: publish.yml on quiltdata/quiltx

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file quiltx-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: quiltx-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 32.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for quiltx-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f0c724744a7f9a4761a01b545e3bea8b1ffe84d22ceff8b7bcf69ca141b41d92
MD5 825048ce6501062cf257bf4ce8ed6cbb
BLAKE2b-256 470c7bb84c26c8e9b3c6448161f243ef0aab5b4ecaab67d46476910e318f3487

See more details on using hashes here.

Provenance

The following attestation bundles were made for quiltx-0.2.0-py3-none-any.whl:

Publisher: publish.yml on quiltdata/quiltx

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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