Skip to content

Commit

Permalink
Update README.rst (#476)
Browse files Browse the repository at this point in the history
  • Loading branch information
bkyryliuk authored May 30, 2024
1 parent 486eaef commit ac09074
Showing 1 changed file with 14 additions and 16 deletions.
30 changes: 14 additions & 16 deletions README.rst
Original file line number Diff line number Diff line change
@@ -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 <http://www.python.org/dev/peps/pep-0249/>`_ and
`SQLAlchemy <http://www.sqlalchemy.org/>`_ interfaces for `Presto <http://prestodb.io/>`_ ,
`Hive <http://hive.apache.org/>`_ and `Trino <https://trino.io/>`_.

Usage
=====
**********

DB-API
------
Expand Down Expand Up @@ -134,7 +132,7 @@ Passing session configuration
)
Requirements
============
************

Install using

Expand All @@ -153,11 +151,11 @@ PyHive works with
- For Hive: `HiveServer2 <https://cwiki.apache.org/confluence/display/Hive/Setting+up+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:
Expand All @@ -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 <https://docs.cloudera.com/documentation/enterprise/release-notes/topics/cdh_vd_cdh_download_510.html>`_ 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.

Expand All @@ -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
Expand All @@ -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 <TCLIServiceURL>``. When left blank, the
Expand Down

0 comments on commit ac09074

Please sign in to comment.