diff --git a/README.rst b/README.rst index 0b6c1e206d..d8c671c3a0 100644 --- a/README.rst +++ b/README.rst @@ -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 `_ 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 `_ (we kept it short). +.. **Note:** This driver does not support big-endian systems. Features -------- -* `Synchronous `_ and `Asynchronous `_ APIs -* `Simple, Prepared, and Batch statements `_ +* `Synchronous `_ and `Asynchronous `_ APIs +* `Simple, Prepared, and Batch statements `_ * Asynchronous IO, parallel execution, request pipelining -* `Connection pooling `_ +* `Connection pooling `_ * Automatic node discovery -* `Automatic reconnection `_ -* Configurable `load balancing `_ and `retry policies `_ -* `Concurrent execution utilities `_ -* `Object mapper `_ -* `Connecting to DataStax Apollo database (cloud) `_ -* DSE Graph execution API -* DSE Geometric type serialization -* DSE PlainText and GSSAPI authentication +* `Automatic reconnection `_ +* Configurable `load balancing `_ and `retry policies `_ +* `Concurrent execution utilities `_ +* `Object mapper `_ Installation ------------ @@ -38,41 +27,41 @@ Installation through pip is recommended:: $ pip install cassandra-driver For more complete installation instructions, see the -`installation guide `_. +`installation guide `_. Documentation ------------- -The documentation can be found online `here `_. +The documentation can be found online `here `_. -A couple of links for getting up to speed: +Information includes: -* `Installation `_ -* `Getting started guide `_ -* `API docs `_ -* `Performance tips `_ +* `Installation `_ +* `Getting started guide `_ +* `API docs `_ +* `Performance tips `_ 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 `_. +`documentation here `_. Contributing ------------ -See `CONTRIBUTING.md `_. +See CONTRIBUTING.md `_. Reporting Problems ------------------ -Please report any bugs and make any feature requests on the -`JIRA `_ issue tracker. +Please report any bugs and make any feature requests by clicking the New Issue button in +`Github `_. -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 `_ -and the `DataStax Community `_. +`mailing list `_ +and the Scylla Users `Slack channel `_. License -------