Metadata-Version: 2.1
Name: crate
Version: 0.33.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: crate db api sqlalchemy
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 :: 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: urllib3 (<2,>=1.9)
Provides-Extra: doc
Requires-Dist: sphinx (<7,>=3.5) ; extra == 'doc'
Requires-Dist: crate-docs-theme (>=0.26.5) ; extra == 'doc'
Provides-Extra: sqlalchemy
Requires-Dist: sqlalchemy (<2.1,>=1.0) ; extra == 'sqlalchemy'
Requires-Dist: geojson (<4,>=2.5.0) ; extra == 'sqlalchemy'
Requires-Dist: backports.zoneinfo (<1) ; (python_version < "3.9") and extra == 'sqlalchemy'
Provides-Extra: test
Requires-Dist: tox (<5,>=3) ; extra == 'test'
Requires-Dist: zope.testing (<6,>=4) ; extra == 'test'
Requires-Dist: zope.testrunner (<7,>=5) ; extra == 'test'
Requires-Dist: zc.customdoctests (<2,>=1.0.1) ; extra == 'test'
Requires-Dist: createcoverage (<2,>=1) ; extra == 'test'
Requires-Dist: dask ; extra == 'test'
Requires-Dist: stopit (<2,>=1.1.2) ; extra == 'test'
Requires-Dist: flake8 (<7,>=4) ; extra == 'test'
Requires-Dist: pandas ; extra == 'test'
Requires-Dist: pytz ; extra == 'test'
Requires-Dist: setuptools (<57) ; extra == 'test'

=====================
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/master/graph/badge.svg
    :target: https://app.codecov.io/gh/crate/crate-python
    :alt: Coverage

.. image:: https://readthedocs.org/projects/crate-python/badge/
    :target: https://crate.io/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://img.shields.io/pypi/dw/crate.svg
    :target: https://pypi.org/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_.

This library:

- Implements the Python `DB API 2.0`_ specification.
- Includes support for SQLAlchemy_ in form of an `SQLAlchemy dialect`_.


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

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

To install the most recent driver version, including the SQLAlchemy dialect
extension, run::

    $ pip install "crate[sqlalchemy]" --upgrade


Documentation and help
======================

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


Contributing
============

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://crate.io/
.. _CrateDB: https://github.com/crate/crate
.. _CrateDB Python Client documentation: https://crate.io/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
.. _PyPI: https://pypi.org/
.. _SQLAlchemy: https://www.sqlalchemy.org
.. _SQLAlchemy dialect: https://docs.sqlalchemy.org/dialects/
.. _StackOverflow: https://stackoverflow.com/tags/cratedb
.. _support channels: https://crate.io/support/
