From b45e081474b901fc24bbc2540dbd7d01ba8770ab Mon Sep 17 00:00:00 2001 From: Laura Novich Date: Mon, 24 Feb 2020 11:31:06 +0200 Subject: [PATCH 1/2] new readme file which is more Scylla less Datastax --- README.rst | 65 +++++++++++++++++++++++------------------------------- 1 file changed, 28 insertions(+), 37 deletions(-) diff --git a/README.rst b/README.rst index 0b6c1e206d..f26ed48a8a 100644 --- a/README.rst +++ b/README.rst @@ -1,32 +1,25 @@ -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:** DataStax products do 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) `_ +* Automatic reconnection +* Configurable load balancing +* Concurrent execution utilities +* Object mapper +* Connecting to DataStax Apollo database (cloud) * DSE Graph execution API * DSE Geometric type serialization * DSE PlainText and GSSAPI authentication @@ -37,42 +30,40 @@ Installation through pip is recommended:: $ pip install cassandra-driver -For more complete installation instructions, see the -`installation guide `_. +For more complete installation instructions, see the installation guide. Documentation ------------- -The documentation can be found online `here `_. +The documentation can be found within this repository. -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 `_. +community) is now maintained as an integral part of this package. 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 ------- From 25e1806b3ea3a8e5816374893f1832f962987534 Mon Sep 17 00:00:00 2001 From: Israel Fruchter Date: Mon, 1 Jun 2020 10:11:51 +0300 Subject: [PATCH 2/2] Bring back the links to docs, since now we upload them to gh-pages --- README.rst | 36 +++++++++++++++++------------------- 1 file changed, 17 insertions(+), 19 deletions(-) diff --git a/README.rst b/README.rst index f26ed48a8a..d8c671c3a0 100644 --- a/README.rst +++ b/README.rst @@ -6,23 +6,19 @@ Scylla Enterprise (2018.1.x+) using exclusively Cassandra's binary protocol and The driver supports Python versions 2.7, 3.4, 3.5, 3.6, 3.7 and 3.8. -.. **Note:** DataStax products do not support big-endian systems. +.. **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 -* 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 ------------ @@ -30,23 +26,25 @@ Installation through pip is recommended:: $ pip install cassandra-driver -For more complete installation instructions, see the installation guide. +For more complete installation instructions, see the +`installation guide `_. Documentation ------------- -The documentation can be found within this repository. +The documentation can be found online `here `_. 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. +community) is now maintained as an integral part of this package. Refer to +`documentation here `_. Contributing ------------