Skip to content

new README file which is more Scylla less Datastax #2

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

Merged
fruch merged 2 commits into from
Jun 1, 2020
Merged

new README file which is more Scylla less Datastax #2

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b45e081
new readme file which is more Scylla less Datastax
lauranovich Feb 24, 2020
25e1806
Bring back the links to docs, since now we upload them to gh-pages
fruch Jun 1, 2020
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
65 changes: 27 additions & 38 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,35 +1,24 @@
DataStax Driver for Apache Cassandra
====================================
Scylla Python Driver
====================

.. image:: https://travis-ci.org/datastax/python-driver.png?branch=master
:target: https://travis-ci.org/datastax/python-driver
A modern, feature-rich and highly-tunable Python client library for Scylla Open Source (2.1+) and Apache Cassandra (2.1+) and
Scylla Enterprise (2018.1.x+) using exclusively Cassandra's binary protocol and Cassandra Query Language v3.

A modern, `feature-rich <https://github.com/datastax/python-driver#features>`_ and highly-tunable Python client library for Apache Cassandra (2.1+) and
DataStax Enterprise (4.7+) using exclusively Cassandra's binary protocol and Cassandra Query Language v3.
The driver supports Python versions 2.7, 3.4, 3.5, 3.6, 3.7 and 3.8.

The driver supports Python 2.7, 3.4, 3.5, 3.6, 3.7 and 3.8.

**Note:** DataStax products do not support big-endian systems.

Feedback Requested
------------------
**Help us focus our efforts!** Provide your input on the `Platform and Runtime Survey <https://docs.google.com/a/datastax.com/forms/d/10wkbKLqmqs91gvhFW5u43y60pg_geZDolVNrxfO5_48/viewform>`_ (we kept it short).
.. **Note:** This driver does not support big-endian systems.

Features
--------
* `Synchronous <http://datastax.github.io/python-driver/api/cassandra/cluster.html#cassandra.cluster.Session.execute>`_ and `Asynchronous <http://datastax.github.io/python-driver/api/cassandra/cluster.html#cassandra.cluster.Session.execute_async>`_ APIs
* `Simple, Prepared, and Batch statements <http://datastax.github.io/python-driver/api/cassandra/query.html#cassandra.query.Statement>`_
* `Synchronous <http://scylladb.github.io/python-driver/api/cassandra/cluster.html#cassandra.cluster.Session.execute>`_ and `Asynchronous <http://scylladb.github.io/python-driver/api/cassandra/cluster.html#cassandra.cluster.Session.execute_async>`_ APIs
* `Simple, Prepared, and Batch statements <http://scylladb.github.io/python-driver/api/cassandra/query.html#cassandra.query.Statement>`_
* Asynchronous IO, parallel execution, request pipelining
* `Connection pooling <http://datastax.github.io/python-driver/api/cassandra/cluster.html#cassandra.cluster.Cluster.get_core_connections_per_host>`_
* `Connection pooling <http://scylladb.github.io/python-driver/api/cassandra/cluster.html#cassandra.cluster.Cluster.get_core_connections_per_host>`_
* Automatic node discovery
* `Automatic reconnection <http://datastax.github.io/python-driver/api/cassandra/policies.html#reconnecting-to-dead-hosts>`_
* Configurable `load balancing <http://datastax.github.io/python-driver/api/cassandra/policies.html#load-balancing>`_ and `retry policies <http://datastax.github.io/python-driver/api/cassandra/policies.html#retrying-failed-operations>`_
* `Concurrent execution utilities <http://datastax.github.io/python-driver/api/cassandra/concurrent.html>`_
* `Object mapper <http://datastax.github.io/python-driver/object_mapper.html>`_
* `Connecting to DataStax Apollo database (cloud) <https://docs.datastax.com/en/developer/python-driver/latest/cloud/>`_
* DSE Graph execution API
* DSE Geometric type serialization
* DSE PlainText and GSSAPI authentication
* `Automatic reconnection <http://scylladb.github.io/python-driver/api/cassandra/policies.html#reconnecting-to-dead-hosts>`_
* Configurable `load balancing <http://scylladb.github.io/python-driver/api/cassandra/policies.html#load-balancing>`_ and `retry policies <http://scylladb.github.io/python-driver/api/cassandra/policies.html#retrying-failed-operations>`_
* `Concurrent execution utilities <http://scylladb.github.io/python-driver/api/cassandra/concurrent.html>`_
* `Object mapper <http://scylladb.github.io/python-driver/object_mapper.html>`_

Installation
------------
Expand All @@ -38,41 +27,41 @@ Installation through pip is recommended::
$ pip install cassandra-driver

For more complete installation instructions, see the
`installation guide <http://datastax.github.io/python-driver/installation.html>`_.
`installation guide <http://scylladb.github.io/python-driver/installation.html>`_.
Copy link

@tzach tzach Jun 3, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should be able to use relative path here and elsewhere

Copy link

@fruch fruch Jun 3, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No we can't, it's not the same domain


Documentation
-------------
The documentation can be found online `here <http://datastax.github.io/python-driver/index.html>`_.
The documentation can be found online `here <http://scylladb.github.io/python-driver/index.html>`_.

A couple of links for getting up to speed:
Information includes:

* `Installation <http://datastax.github.io/python-driver/installation.html>`_
* `Getting started guide <http://datastax.github.io/python-driver/getting_started.html>`_
* `API docs <http://datastax.github.io/python-driver/api/index.html>`_
* `Performance tips <http://datastax.github.io/python-driver/performance.html>`_
* `Installation <http://scylladb.github.io/python-driver/installation.html>`_
* `Getting started guide <http://scylladb.github.io/python-driver/getting_started.html>`_
* `API docs <http://scylladb.github.io/python-driver/api/index.html>`_
* `Performance tips <http://scylladb.github.io/python-driver/performance.html>`_

Object Mapper
-------------
cqlengine (originally developed by Blake Eggleston and Jon Haddad, with contributions from the
community) is now maintained as an integral part of this package. Refer to
`documentation here <http://datastax.github.io/python-driver/object_mapper.html>`_.
`documentation here <http://scylladb.github.io/python-driver/object_mapper.html>`_.

Contributing
------------
See `CONTRIBUTING.md <https://github.com/datastax/python-driver/blob/master/CONTRIBUTING.rst>`_.
See CONTRIBUTING.md <https://github.com/scylladb/python-driver/blob/master/CONTRIBUTING.rst>`_.

Reporting Problems
------------------
Please report any bugs and make any feature requests on the
`JIRA <https://datastax-oss.atlassian.net/browse/PYTHON>`_ issue tracker.
Please report any bugs and make any feature requests by clicking the New Issue button in
`Github <https://github.com/scylladb/python-driver/issues>`_.

If you would like to contribute, please feel free to open a pull request.
If you would like to contribute, please feel free to send a pull request.

Getting Help
------------
Your best options for getting help with the driver are the
`mailing list <https://groups.google.com/a/lists.datastax.com/forum/#!forum/python-driver-user>`_
and the `DataStax Community <https://community.datastax.com>`_.
`mailing list <https://groups.google.com/forum/#!forum/scylladb-users>`_
and the Scylla Users `Slack channel <https://scylladb-users.slack.com>`_.

License
-------
Expand Down