# CrateDB Toolkit
[](https://github.com/crate/cratedb-toolkit/actions/workflows/main.yml)
[](https://codecov.io/gh/crate/cratedb-toolkit/)
[](https://pypi.org/project/cratedb-toolkit/)
[](https://github.com/crate/cratedb-toolkit/blob/main/LICENSE)
[](https://pypi.org/project/cratedb-toolkit/)
[](https://pypi.org/project/cratedb-toolkit/)
[](https://pepy.tech/project/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 using it as a library.
## Install
Install package.
```shell
pip install --upgrade cratedb-toolkit
```
Verify installation.
```shell
ctk --version
```
Run with Docker.
```shell
alias ctk="docker run --rm ghcr.io/crate/cratedb-toolkit ctk"
ctk --version
```
## Development
Contributions are very much welcome. Please visit the [](#sandbox)
documentation to learn about how to spin up a sandbox environment on your
workstation, or create a [ticket][Issues] to report a bug or share an idea
about a possible feature.
[Changelog]: https://github.com/crate/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-toolkit.readthedocs.io/
[DWIM]: https://en.wikipedia.org/wiki/DWIM
[Issues]: https://github.com/crate/cratedb-toolkit/issues
[License]: https://github.com/crate/cratedb-toolkit/blob/main/LICENSE
[PyPI]: https://pypi.org/project/cratedb-toolkit/
[Source code]: https://github.com/crate/cratedb-toolkit
[UX]: https://en.wikipedia.org/wiki/User_experience
Raw data
{
"_id": null,
"home_page": null,
"name": "cratedb-toolkit",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "cratedb, data-processing, data-retention, toolkit",
"author": null,
"author_email": "Niklas Schmidtmer <niklas@crate.io>, Marija Selakovic <marija@crate.io>, Andreas Motl <andreas.motl@crate.io>",
"download_url": "https://files.pythonhosted.org/packages/0b/05/9c2ebe8c318fb8f27ea3a56ba5725ece148780f8672c36c7c612d4744f45/cratedb_toolkit-0.0.30.tar.gz",
"platform": null,
"description": "# CrateDB Toolkit\n\n[](https://github.com/crate/cratedb-toolkit/actions/workflows/main.yml)\n[](https://codecov.io/gh/crate/cratedb-toolkit/)\n[](https://pypi.org/project/cratedb-toolkit/)\n\n[](https://github.com/crate/cratedb-toolkit/blob/main/LICENSE)\n[](https://pypi.org/project/cratedb-toolkit/)\n[](https://pypi.org/project/cratedb-toolkit/)\n[](https://pepy.tech/project/cratedb-toolkit/)\n\n\n\u00bb [Documentation]\n| [Changelog]\n| [Community Forum]\n| [PyPI]\n| [Issues]\n| [Source code]\n| [License]\n| [CrateDB]\n\n\n## About\n\nThis software package includes a range of modules and subsystems to work\nwith CrateDB and CrateDB Cloud efficiently.\n\nYou can use CrateDB Toolkit to run data I/O procedures and automation tasks\nof different kinds around CrateDB and CrateDB Cloud. It can be used both as\na standalone program, and as a library.\n\nIt aims for [DWIM]-like usefulness and [UX], and provides CLI and HTTP\ninterfaces, and others.\n\n\n## Status\n\nPlease note that the `cratedb-toolkit` package contains alpha-, beta- and\nincubation-quality code, and as such, is considered to be a work in progress.\nContributions of all kinds are much welcome, in order to make it more solid,\nand to add features.\n\nBreaking changes should be expected until a 1.0 release, so version pinning is\nstrongly recommended, especially when using it as a library.\n\n\n## Install\n\nInstall package.\n```shell\npip install --upgrade cratedb-toolkit\n```\n\nVerify installation.\n```shell\nctk --version\n```\n\nRun with Docker.\n```shell\nalias ctk=\"docker run --rm ghcr.io/crate/cratedb-toolkit ctk\"\nctk --version\n```\n\n\n## Development\n\nContributions are very much welcome. Please visit the [](#sandbox)\ndocumentation to learn about how to spin up a sandbox environment on your\nworkstation, or create a [ticket][Issues] to report a bug or share an idea\nabout a possible feature.\n\n\n\n[Changelog]: https://github.com/crate/cratedb-toolkit/blob/main/CHANGES.md\n[Community Forum]: https://community.crate.io/\n[CrateDB]: https://crate.io/products/cratedb\n[CrateDB Cloud]: https://console.cratedb.cloud/\n[Documentation]: https://cratedb-toolkit.readthedocs.io/\n[DWIM]: https://en.wikipedia.org/wiki/DWIM\n[Issues]: https://github.com/crate/cratedb-toolkit/issues\n[License]: https://github.com/crate/cratedb-toolkit/blob/main/LICENSE\n[PyPI]: https://pypi.org/project/cratedb-toolkit/\n[Source code]: https://github.com/crate/cratedb-toolkit\n[UX]: https://en.wikipedia.org/wiki/User_experience\n",
"bugtrack_url": null,
"license": "AGPL 3, EUPL 1.2",
"summary": "CrateDB Toolkit",
"version": "0.0.30",
"project_urls": {
"Changelog": "https://github.com/crate/cratedb-toolkit/blob/main/CHANGES.md",
"Documentation": "https://cratedb-toolkit.readthedocs.io/",
"Homepage": "https://cratedb-toolkit.readthedocs.io/",
"Issues": "https://github.com/crate/cratedb-toolkit/issues",
"Repository": "https://github.com/crate/cratedb-toolkit"
},
"split_keywords": [
"cratedb",
" data-processing",
" data-retention",
" toolkit"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "304ac60f7dbf9d453e08c6576e101b6b86d85ce43d5f55013301cc335032e574",
"md5": "5b945a27882be370120b22d85473e0ca",
"sha256": "836538e599dda01b3e02c7d0b1f8bd95e6c281a909ad2b268c0dee89fe3f4468"
},
"downloads": -1,
"filename": "cratedb_toolkit-0.0.30-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5b945a27882be370120b22d85473e0ca",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 153906,
"upload_time": "2025-01-13T09:18:58",
"upload_time_iso_8601": "2025-01-13T09:18:58.472038Z",
"url": "https://files.pythonhosted.org/packages/30/4a/c60f7dbf9d453e08c6576e101b6b86d85ce43d5f55013301cc335032e574/cratedb_toolkit-0.0.30-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0b059c2ebe8c318fb8f27ea3a56ba5725ece148780f8672c36c7c612d4744f45",
"md5": "8bef35cf269d0d170c92843837e79d8c",
"sha256": "fa2238ca9e36ea0e76106a5f5ccf6b5ce73d9e0ce22d0a667ec5c7804125ce03"
},
"downloads": -1,
"filename": "cratedb_toolkit-0.0.30.tar.gz",
"has_sig": false,
"md5_digest": "8bef35cf269d0d170c92843837e79d8c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 159342,
"upload_time": "2025-01-13T09:19:01",
"upload_time_iso_8601": "2025-01-13T09:19:01.164472Z",
"url": "https://files.pythonhosted.org/packages/0b/05/9c2ebe8c318fb8f27ea3a56ba5725ece148780f8672c36c7c612d4744f45/cratedb_toolkit-0.0.30.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-13 09:19:01",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "crate",
"github_project": "cratedb-toolkit",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "cratedb-toolkit"
}
JSON
