Metadata-Version: 2.1
Name: cratedb-toolkit
Version: 0.0.1
Summary: CrateDB Toolkit
Author-email: Niklas Schmidtmer <niklas@crate.io>, Marija Selakovic <marija@crate.io>, Andreas Motl <andreas.motl@crate.io>
License: AGPL 3, EUPL 1.2
Project-URL: changelog, https://github.com/crate-workbench/cratedb-toolkit/blob/main/CHANGES.rst
Project-URL: documentation, https://github.com/crate-workbench/cratedb-toolkit
Project-URL: homepage, https://github.com/crate-workbench/cratedb-toolkit
Project-URL: repository, https://github.com/crate-workbench/cratedb-toolkit
Keywords: cratedb,data-processing,data-retention,toolkit
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Customer Service
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: End Users/Desktop
Classifier: Intended Audience :: Information Technology
Classifier: Intended Audience :: Manufacturing
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: System Administrators
Classifier: Intended Audience :: Telecommunications Industry
Classifier: License :: OSI Approved :: European Union Public Licence 1.2 (EUPL 1.2)
Classifier: License :: OSI Approved :: GNU Affero General Public License v3
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX :: Linux
Classifier: Operating System :: Unix
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Topic :: Adaptive Technologies
Classifier: Topic :: Communications
Classifier: Topic :: Database
Classifier: Topic :: Documentation
Classifier: Topic :: Education
Classifier: Topic :: Internet
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Office/Business
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Software Development :: Embedded Systems
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Software Development :: Object Brokering
Classifier: Topic :: Software Development :: Pre-processors
Classifier: Topic :: Software Development :: Quality Assurance
Classifier: Topic :: Software Development :: Testing
Classifier: Topic :: Software Development :: Version Control
Classifier: Topic :: System :: Archiving
Classifier: Topic :: System :: Benchmark
Classifier: Topic :: System :: Clustering
Classifier: Topic :: System :: Distributed Computing
Classifier: Topic :: System :: Hardware
Classifier: Topic :: System :: Logging
Classifier: Topic :: System :: Monitoring
Classifier: Topic :: System :: Networking
Classifier: Topic :: System :: Systems Administration
Classifier: Topic :: Text Processing
Classifier: Topic :: Utilities
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: boltons <24
Requires-Dist: click <9
Requires-Dist: click-aliases <2
Requires-Dist: colorama <1
Requires-Dist: colorlog
Requires-Dist: crash
Requires-Dist: crate[sqlalchemy] >=0.34
Requires-Dist: sqlalchemy >=2
Provides-Extra: develop
Requires-Dist: black <24 ; extra == 'develop'
Requires-Dist: mypy ==1.5.1 ; extra == 'develop'
Requires-Dist: poethepoet <0.25 ; extra == 'develop'
Requires-Dist: pyproject-fmt <1.3 ; extra == 'develop'
Requires-Dist: ruff ==0.0.292 ; extra == 'develop'
Requires-Dist: validate-pyproject <0.15 ; extra == 'develop'
Provides-Extra: release
Requires-Dist: build <2 ; extra == 'release'
Requires-Dist: twine <5 ; extra == 'release'
Provides-Extra: test
Requires-Dist: pytest <8 ; extra == 'test'
Requires-Dist: pytest-cov <5 ; extra == 'test'
Requires-Dist: pytest-mock <4 ; extra == 'test'
Requires-Dist: testcontainers <4 ; extra == 'test'
Requires-Dist: testcontainers-azurite ==0.0.1rc1 ; extra == 'test'
Requires-Dist: testcontainers-minio ==0.0.1rc1 ; extra == 'test'

# CrateDB Toolkit

[![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/)
[![Python versions](https://img.shields.io/pypi/pyversions/cratedb-toolkit.svg)](https://pypi.org/project/cratedb-toolkit/)

[![License](https://img.shields.io/github/license/crate-workbench/cratedb-toolkit.svg)](https://github.com/crate-workbench/cratedb-toolkit/blob/main/LICENSE)
[![Status](https://img.shields.io/pypi/status/cratedb-toolkit.svg)](https://pypi.org/project/cratedb-toolkit/)
[![PyPI](https://img.shields.io/pypi/v/cratedb-toolkit.svg)](https://pypi.org/project/cratedb-toolkit/)
[![Downloads](https://pepy.tech/badge/cratedb-toolkit/month)](https://pepy.tech/project/cratedb-toolkit/)


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


## About

This package is a work in progress, and includes different kinds of modules and
subsystems to work with CrateDB and CrateDB Cloud efficiently.


## Caveat

Please note that the `cratedb-toolkit` package contains alpha- and beta-quality
software, and as such, is considered to be a work in progress. Contributions of
all kinds are very 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.
```shell
pip install --upgrade cratedb-toolkit
```

Verify installation.
```shell
cratedb-toolkit --version
```

Run with Docker.
```shell
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].


[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/
[development sandbox documentation]: https://github.com/crate-workbench/cratedb-toolkit/blob/main/doc/sandbox.md
[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
