pilosus/cratedb-toolkit

CrateDB Toolkit.

CrateDB Toolkit

» Documentation | Changelog | Community Forum | PyPI | Issues | Source code | License | CrateDB

About

This software package includes a range of modules and subsystems to work with CrateDB and CrateDB Cloud efficiently.

You can use CrateDB Toolkit to run data I/O procedures and automation tasks of different kinds around CrateDB and CrateDB Cloud. It can be used both as a standalone program, and as a library.

It aims for DWIM-like usefulness and UX, and provides CLI and HTTP interfaces, and others.

Status

Please note that the cratedb-toolkit package contains alpha-, beta- and incubation-quality code, and as such, is considered to be a work in progress. Contributions of all kinds are much welcome, in order to make it more solid, and to add features.

Breaking changes should be expected until a 1.0 release, so version pinning is strongly recommended, especially when you use it as a library.

Install

Install package.

pip install --upgrade cratedb-toolkit

Verify installation.

cratedb-toolkit --version

Run with Docker.

docker run --rm "ghcr.io/crate-workbench/cratedb-toolkit" cratedb-toolkit --version

Development

For installing a development sandbox, please refer to the development sandbox documentation.