From ac09074a652fd50e10b57a7f0bbc4f6410961301 Mon Sep 17 00:00:00 2001 From: Bogdan Date: Thu, 30 May 2024 15:35:22 -0700 Subject: [PATCH] Update README.rst (#476) --- README.rst | 30 ++++++++++++++---------------- 1 file changed, 14 insertions(+), 16 deletions(-) diff --git a/README.rst b/README.rst index 1f4db670..cbdcce10 100644 --- a/README.rst +++ b/README.rst @@ -1,26 +1,24 @@ -================================ -Pyhive project has been donated to Apache Kyuubi. +======================================================== +PyHive project has been donated to Apache Kyuubi +======================================================== You can follow it's development and report any issues you are experiencing here: https://github.com/apache/kyuubi/tree/master/python/pyhive -================================ +Legacy notes / instructions +=========================== -.. image:: https://travis-ci.org/dropbox/PyHive.svg?branch=master - :target: https://travis-ci.org/dropbox/PyHive -.. image:: https://img.shields.io/codecov/c/github/dropbox/PyHive.svg - -====== PyHive -====== +********** + PyHive is a collection of Python `DB-API `_ and `SQLAlchemy `_ interfaces for `Presto `_ , `Hive `_ and `Trino `_. Usage -===== +********** DB-API ------ @@ -134,7 +132,7 @@ Passing session configuration ) Requirements -============ +************ Install using @@ -153,11 +151,11 @@ PyHive works with - For Hive: `HiveServer2 `_ daemon Changelog -========= +********* See https://github.com/dropbox/PyHive/releases. Contributing -============ +************ - Please fill out the Dropbox Contributor License Agreement at https://opensource.dropbox.com/cla/ and note this in your pull request. - Changes must come with tests, with the exception of trivial things like fixing comments. See .travis.yml for the test environment setup. - Notes on project scope: @@ -168,7 +166,7 @@ Contributing For example, the Presto code takes an arbitrary ``requests_session`` argument for customizing HTTP calls, as opposed to having a separate parameter/branch for each ``requests`` option. Tips for test environment setup -================================ +**************************************** You can setup test environment by following ``.travis.yaml`` in this repository. It uses `Cloudera's CDH 5 `_ which requires username and password for download. It may not be feasible for everyone to get those credentials. Hence below are alternative instructions to setup test environment. @@ -188,7 +186,7 @@ Then run:: docker-compose up -d Testing -======= +******* .. image:: https://travis-ci.org/dropbox/PyHive.svg :target: https://travis-ci.org/dropbox/PyHive .. image:: http://codecov.io/github/dropbox/PyHive/coverage.svg?branch=master @@ -207,7 +205,7 @@ WARNING: This drops/creates tables named ``one_row``, ``one_row_complex``, and ` database called ``pyhive_test_database``. Updating TCLIService -==================== +******************** The TCLIService module is autogenerated using a ``TCLIService.thrift`` file. To update it, the ``generate.py`` file can be used: ``python generate.py ``. When left blank, the