Rename package to cratedb-toolkit

Author: amotl

CHANGES.md

@@ -1,4 +1,4 @@
-# Changes for cratedb-retention
+# Changes for cratedb-toolkit
 
 ## Unreleased
 

README.md

@@ -1,7 +1,7 @@
 # CrateDB data processing toolkit
 
-[![Tests](https://github.com/crate-workbench/cratedb-retention/actions/workflows/main.yml/badge.svg)](https://github.com/crate-workbench/cratedb-retention/actions/workflows/main.yml)
-[![Test coverage](https://img.shields.io/codecov/c/gh/crate-workbench/cratedb-retention.svg)](https://codecov.io/gh/crate-workbench/cratedb-retention/)
+[![Tests](https://github.com/crate-workbench/cratedb-toolkit/actions/workflows/main.yml/badge.svg)](https://github.com/crate-workbench/cratedb-toolkit/actions/workflows/main.yml)
+[![Test coverage](https://img.shields.io/codecov/c/gh/crate-workbench/cratedb-toolkit.svg)](https://codecov.io/gh/crate-workbench/cratedb-toolkit/)
 
 » [Documentation]
 | [Changelog]
@@ -33,17 +33,17 @@ strongly recommended, especially when you use it as a library.
 
 Install package.
 ```shell
-pip install --upgrade git+https://github.com/crate-workbench/cratedb-retention
+pip install --upgrade git+https://github.com/crate-workbench/cratedb-toolkit
 ```
 
 Verify installation.
 ```shell
-cratedb-retention --version
+cratedb-toolkit --version
 ```
 
 Run with Docker.
 ```shell
-docker run --rm "ghcr.io/crate-workbench/cratedb-retention" cratedb-retention --version
+docker run --rm "ghcr.io/crate-workbench/cratedb-toolkit" cratedb-toolkit --version
 ```
 
 
@@ -53,12 +53,12 @@ For installing a development sandbox, please refer to the [development sandbox
 documentation](./doc/sandbox.md).
 
 
-[Changelog]: https://github.com/crate-workbench/cratedb-retention/blob/main/CHANGES.md
+[Changelog]: https://github.com/crate-workbench/cratedb-toolkit/blob/main/CHANGES.md
 [Community Forum]: https://community.crate.io/
 [CrateDB]: https://crate.io/products/cratedb
 [CrateDB Cloud]: https://console.cratedb.cloud/
-[Documentation]: https://cratedb-retention.readthedocs.io/
-[Issues]: https://github.com/crate-workbench/cratedb-retention/issues
-[License]: https://github.com/crate-workbench/cratedb-retention/blob/main/LICENSE
-[PyPI]: https://pypi.org/project/cratedb-retention/
-[Source code]: https://github.com/crate-workbench/cratedb-retention
+[Documentation]: https://cratedb-toolkit.readthedocs.io/
+[Issues]: https://github.com/crate-workbench/cratedb-toolkit/issues
+[License]: https://github.com/crate-workbench/cratedb-toolkit/blob/main/LICENSE
+[PyPI]: https://pypi.org/project/cratedb-toolkit/
+[Source code]: https://github.com/crate-workbench/cratedb-toolkit

cratedb_toolkit/cli.py

@@ -0,0 +1,13 @@
+import click
+from click_aliases import ClickAliasedGroup
+
+from cratedb_toolkit.util.cli import boot_click
+
+
+@click.group(cls=ClickAliasedGroup)  # type: ignore[arg-type]
+@click.option("--verbose", is_flag=True, required=False, help="Turn on logging")
+@click.option("--debug", is_flag=True, required=False, help="Turn on logging with debug level")
+@click.version_option()
+@click.pass_context
+def cli(ctx: click.Context, verbose: bool, debug: bool):
+    return boot_click(ctx, verbose, debug)

doc/sandbox.md

@@ -12,8 +12,8 @@ source .venv/bin/activate
 
 Acquire sources.
 ```shell
-git clone https://github.com/crate-workbench/cratedb-retention
-cd cratedb-retention
+git clone https://github.com/crate-workbench/cratedb-toolkit
+cd cratedb-toolkit
 ```
 
 Install project in sandbox mode.

examples/retention_edit.py

@@ -18,7 +18,7 @@
 ::
 
     # Install package
-    pip install cratedb-retention
+    pip install cratedb-toolkit
 
     # General.
     python examples/retention_edit.py crate://<USERNAME>:<PASSWORD>@<HOSTNAME>:4200?ssl=true

examples/retention_retire_cutoff.py

@@ -24,7 +24,7 @@
 ::
 
     # Install package
-    pip install cratedb-retention
+    pip install cratedb-toolkit
 
     # General.
     python examples/retention_retire_cutoff.py crate://<USERNAME>:<PASSWORD>@<HOSTNAME>:4200?ssl=true

pyproject.toml

@@ -114,11 +114,12 @@ test = [
   "testcontainers-minio==0.0.1rc1",
 ]
 [project.urls]
-changelog = "https://github.com/crate-workbench/cratedb-retention/blob/main/CHANGES.rst"
-documentation = "https://github.com/crate-workbench/cratedb-retention"
-homepage = "https://github.com/crate-workbench/cratedb-retention"
-repository = "https://github.com/crate-workbench/cratedb-retention"
+changelog = "https://github.com/crate-workbench/cratedb-toolkit/blob/main/CHANGES.rst"
+documentation = "https://github.com/crate-workbench/cratedb-toolkit"
+homepage = "https://github.com/crate-workbench/cratedb-toolkit"
+repository = "https://github.com/crate-workbench/cratedb-toolkit"
 [project.scripts]
+cratedb-toolkit = "cratedb_toolkit.cli:cli"
 cratedb-retention = "cratedb_toolkit.retention.cli:cli"
 
 [tool.black]

release/oci/selftest.sh

@@ -8,5 +8,5 @@ set -e
 
 flavor=$1
 
-echo "Invoking cratedb-retention"
-cratedb-retention --version
+echo "Invoking cratedb-toolkit"
+cratedb-toolkit --version