Metadata-Version: 2.2
Name: crate
Version: 2.0.0
Summary: CrateDB Python Client
Home-page: https://github.com/crate/crate-python
Author: Crate.io
Author-email: office@crate.io
License: Apache License 2.0
Keywords: cratedb db api dbapi database sql http rdbms olap
Platform: any
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
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: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Topic :: Database
Requires-Python: >=3.6
Description-Content-Type: text/x-rst
License-File: LICENSE
License-File: NOTICE
Requires-Dist: orjson<4
Requires-Dist: urllib3
Requires-Dist: verlib2
Provides-Extra: doc
Requires-Dist: crate-docs-theme>=0.26.5; extra == "doc"
Requires-Dist: sphinx<9,>=3.5; extra == "doc"
Provides-Extra: test
Requires-Dist: backports.zoneinfo<1; python_version < "3.9" and extra == "test"
Requires-Dist: certifi; extra == "test"
Requires-Dist: createcoverage<2,>=1; extra == "test"
Requires-Dist: mypy<1.15; extra == "test"
Requires-Dist: poethepoet<0.33; extra == "test"
Requires-Dist: ruff<0.10; extra == "test"
Requires-Dist: stopit<2,>=1.1.2; extra == "test"
Requires-Dist: pytz; extra == "test"
Requires-Dist: zc.customdoctests<2,>=1.0.1; extra == "test"
Requires-Dist: zope.testing<6,>=4; extra == "test"
Requires-Dist: zope.testrunner<7,>=5; extra == "test"
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: keywords
Dynamic: license
Dynamic: platform
Dynamic: provides-extra
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

=====================
CrateDB Python Client
=====================

.. image:: https://github.com/crate/crate-python/workflows/Tests/badge.svg
    :target: https://github.com/crate/crate-python/actions?workflow=Tests
    :alt: Build status

.. image:: https://codecov.io/gh/crate/crate-python/branch/main/graph/badge.svg
    :target: https://app.codecov.io/gh/crate/crate-python
    :alt: Coverage

.. image:: https://readthedocs.org/projects/crate-python/badge/
    :target: https://cratedb.com/docs/python/
    :alt: Build status (documentation)

.. image:: https://img.shields.io/pypi/v/crate.svg
    :target: https://pypi.org/project/crate/
    :alt: PyPI Version

.. image:: https://img.shields.io/pypi/pyversions/crate.svg
    :target: https://pypi.org/project/crate/
    :alt: Python Version

.. image:: https://static.pepy.tech/badge/crate/month
    :target: https://pepy.tech/project/crate
    :alt: PyPI Downloads

.. image:: https://img.shields.io/pypi/wheel/crate.svg
    :target: https://pypi.org/project/crate/
    :alt: Wheel

.. image:: https://img.shields.io/pypi/status/crate.svg
    :target: https://pypi.org/project/crate/
    :alt: Status

.. image:: https://img.shields.io/pypi/l/crate.svg
    :target: https://pypi.org/project/crate/
    :alt: License


|

A Python client library for `CrateDB`_, implementing the Python `DB API 2.0`_
specification.

The CrateDB dialect for `SQLAlchemy`_ is provided by the `sqlalchemy-cratedb`_
package, see also `sqlalchemy-cratedb documentation`_.


Installation
============

The CrateDB Python client is available as package `crate`_ on `PyPI`_.

To install the most recent driver version, run::

    $ pip install --upgrade crate


Migration Notes
===============

If you are migrating from previous versions of ``crate[sqlalchemy]<1.0.0``, you
will find that the newer releases ``crate>=1.0.0`` no longer include the
SQLAlchemy dialect for CrateDB.

See `migrate to sqlalchemy-cratedb`_ for relevant guidelines about how to
successfully migrate to the `sqlalchemy-cratedb`_ package.


Documentation and Help
======================

- `CrateDB Python Client documentation`_
- `CrateDB reference documentation`_
- `Developer documentation`_
- `Contributing`_
- Other `support channels`_


Contributions
=============

The CrateDB Python client library is an open source project, and is `managed on
GitHub`_. We appreciate contributions of any kind.


.. _Contributing: CONTRIBUTING.rst
.. _crate: https://pypi.org/project/crate/
.. _Crate.io: https://cratedb.com/
.. _CrateDB: https://github.com/crate/crate
.. _CrateDB Python Client documentation: https://cratedb.com/docs/python/
.. _CrateDB reference documentation: https://crate.io/docs/reference/
.. _DB API 2.0: https://peps.python.org/pep-0249/
.. _Developer documentation: DEVELOP.rst
.. _managed on GitHub: https://github.com/crate/crate-python
.. _migrate to sqlalchemy-cratedb: https://cratedb.com/docs/sqlalchemy-cratedb/migrate-from-crate-client.html
.. _PyPI: https://pypi.org/
.. _SQLAlchemy: https://www.sqlalchemy.org/
.. _sqlalchemy-cratedb: https://github.com/crate/sqlalchemy-cratedb
.. _sqlalchemy-cratedb documentation: https://cratedb.com/docs/sqlalchemy-cratedb/
.. _StackOverflow: https://stackoverflow.com/tags/cratedb
.. _support channels: https://cratedb.com/support/
