Skip to content

Commit

Permalink
Rename package to cratedb-toolkit
Browse files Browse the repository at this point in the history
  • Loading branch information
amotl committed Oct 10, 2023
1 parent 47ad039 commit 468fd27
Show file tree
Hide file tree
Showing 8 changed files with 36 additions and 22 deletions.
2 changes: 1 addition & 1 deletion CHANGES.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Changes for cratedb-retention
# Changes for cratedb-toolkit

## Unreleased

Expand Down
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -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]
Expand Down Expand Up @@ -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
```


Expand All @@ -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
13 changes: 13 additions & 0 deletions cratedb_toolkit/cli.py
Original file line number Diff line number Diff line change
@@ -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)
4 changes: 2 additions & 2 deletions doc/sandbox.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion examples/retention_edit.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion examples/retention_retire_cutoff.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
9 changes: 5 additions & 4 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down
4 changes: 2 additions & 2 deletions release/oci/selftest.sh
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,5 @@ set -e

flavor=$1

echo "Invoking cratedb-retention"
cratedb-retention --version
echo "Invoking cratedb-toolkit"
cratedb-toolkit --version

0 comments on commit 468fd27

Please sign in to comment.