# 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/59/12/5176cf7f65f203cc225d7723bd1fb4801aaa6dc3cadb70f8c351692ee558/cratedb_toolkit-0.0.31.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.31",
"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": null,
"digests": {
"blake2b_256": "a29ef761b31c8e1e84cd7c706ce8b6edc046f8342833c5ba2f2188447b6be2f6",
"md5": "2cb71b6cc01605456e9971a8627714d3",
"sha256": "10cbf79399657791046aa26c7977182ce0ac0dbd870d2ac2c0d1fbc6a1df6d75"
},
"downloads": -1,
"filename": "cratedb_toolkit-0.0.31-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2cb71b6cc01605456e9971a8627714d3",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 157660,
"upload_time": "2025-01-31T02:06:06",
"upload_time_iso_8601": "2025-01-31T02:06:06.547464Z",
"url": "https://files.pythonhosted.org/packages/a2/9e/f761b31c8e1e84cd7c706ce8b6edc046f8342833c5ba2f2188447b6be2f6/cratedb_toolkit-0.0.31-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "59125176cf7f65f203cc225d7723bd1fb4801aaa6dc3cadb70f8c351692ee558",
"md5": "bf7bfbb3548eed02203cc9927319559b",
"sha256": "6633cdcd028f4dfe8f97abc29d63e47a8bc69ecef10b368487f084a986911ffa"
},
"downloads": -1,
"filename": "cratedb_toolkit-0.0.31.tar.gz",
"has_sig": false,
"md5_digest": "bf7bfbb3548eed02203cc9927319559b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 163697,
"upload_time": "2025-01-31T02:06:08",
"upload_time_iso_8601": "2025-01-31T02:06:08.539128Z",
"url": "https://files.pythonhosted.org/packages/59/12/5176cf7f65f203cc225d7723bd1fb4801aaa6dc3cadb70f8c351692ee558/cratedb_toolkit-0.0.31.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-31 02:06:08",
"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
