Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

README: Refer to new SQLAlchemy dialect sqlalchemy-cratedb #621

Merged
merged 3 commits into from
Jun 17, 2024
Merged

README: Refer to new SQLAlchemy dialect sqlalchemy-cratedb #621

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1737833
Chore: Update badge about PyPI download numbers
amotl Jun 16, 2024
9b39925
README: Refer to new SQLAlchemy dialect `sqlalchemy-cratedb`
amotl Jun 16, 2024
7dfff63
README: Update to cratedb.com
amotl Jun 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 15 additions & 16 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ CrateDB Python Client
:alt: Coverage

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

.. image:: https://img.shields.io/pypi/v/crate.svg
Expand All @@ -22,8 +22,8 @@ CrateDB Python Client
:target: https://pypi.org/project/crate/
:alt: Python Version

.. image:: https://img.shields.io/pypi/dw/crate.svg
:target: https://pypi.org/project/crate/
.. 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
Expand All @@ -41,23 +41,21 @@ CrateDB Python Client

|

A Python client library for CrateDB_.

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

- Implements the Python `DB API 2.0`_ specification.
- Includes support for SQLAlchemy_ in form of an `SQLAlchemy dialect`_.
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, including the SQLAlchemy dialect
extension, run::
To install the most recent driver version, run::

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


Documentation and help
Expand All @@ -79,15 +77,16 @@ GitHub`_. We appreciate contributions of any kind.

.. _Contributing: CONTRIBUTING.rst
.. _crate: https://pypi.org/project/crate/
.. _Crate.io: https://crate.io/
.. _Crate.io: https://cratedb.com/
.. _CrateDB: https://github.com/crate/crate
.. _CrateDB Python Client documentation: https://crate.io/docs/python/
.. _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
.. _PyPI: https://pypi.org/
.. _SQLAlchemy: https://www.sqlalchemy.org
.. _SQLAlchemy dialect: https://docs.sqlalchemy.org/dialects/
.. _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://crate.io/support/
.. _support channels: https://cratedb.com/support/