From 402810aea4b5dfa0d5be4e37718159a331874150 Mon Sep 17 00:00:00 2001 From: Anthony Tuininga Date: Tue, 7 Mar 2017 17:07:56 -0700 Subject: [PATCH] Improve clarity and structure of README.txt. --- README.txt | 62 +++++++++++++++++++++++++++--------------------------- 1 file changed, 31 insertions(+), 31 deletions(-) diff --git a/README.txt b/README.txt index 61d6ee3..de336ab 100644 --- a/README.txt +++ b/README.txt @@ -1,54 +1,58 @@ Open Source Python/Oracle Utility - cx_Oracle --------------------------------------------- - -cx_Oracle is a Python extension module that allows access to Oracle and -conforms to the Python database API 2.0 specifications with a number of -additions. The time data type is not supported by Oracle and is therefore not -implemented. The method cursor.nextset() is not implemented either as the DB -API specification assumes an implementation of cursors that does not fit well -with Oracle's implementation of cursors and implicit results. See the method +cx_Oracle is a Python extension module that enables access to Oracle Database +and conforms to the Python database API 2.0 specifications with a considerable +number of additions and a couple of exclusions. The time data type is not +supported by Oracle and is therefore not implemented. The method +cursor.nextset() is not implemented either as the DB API specification assumes +an implementation of cursors that does not fit well with Oracle's +implementation of cursors and implicit results. See the method cursor.getimplicitresults() for more information. See http://www.python.org/topics/database/DatabaseAPI-2.0.html for more -information on the Python database API specification. See the included -documentation for additional information. +information on the Python database API specification. See the documentation at +http://cx-oracle.readthedocs.io for a complete description of the module's +capabilities. + +cx_Oracle is licensed under a BSD license which you can find at +http://cx-oracle.readthedocs.io/en/latest/license.html. + +Please note that an Oracle client (or server) installation is required in order +to use cx_Oracle. If you do not require the tools that come with a full client +installation, it is recommended to install the Instant Client +(http://www.oracle.com/technetwork/database/features/instant-client/index.html) +which is far easier to install. For feedback or patches, contact Anthony Tuininga at anthony.tuininga@gmail.com. For help or to ask questions, please use the mailing list at http://lists.sourceforge.net/lists/listinfo/cx-oracle-users. -Please note that an Oracle client (or server) installation is required in order -to use cx_Oracle. If you do not require the tools that come with a full client -installation, it is recommended to install the Instant Client which is far -easier to install. - -Binary Install --------------- -Place the file cx_Oracle.pyd or cx_Oracle.so anywhere on your Python path. - - -Source Install --------------- -This module has been built with Oracle 11g and 12c on Linux, Windows and macOS. -Others have reported success with other platforms. - -For simplified installation use pip +Installation +------------ +Binaries for some platforms and Oracle versions are available at +https://pypi.python.org/pypi/cx_Oracle. If you prefer to build your own you +can use this command pip install cx_Oracle -Otherwise, you can use the provided setup.py to build and install the module +which will download the source package, build and install it. Otherwise, you +can download the source package directly from PyPI, extract it and run these +commands instead python setup.py build python setup.py install +This module has been built with Oracle client 11.1, 12.1 and 12.2 on Linux and +Windows. Others have reported success with other platforms such as macOS. + See BUILD.txt for additional information. Usage Example ------------- -from __future__ import print_function +from __future__ import print_function # needed for Python 2.x import cx_Oracle @@ -74,7 +78,3 @@ samples in the samples directory. You can also look at the scripts in the cx_OracleTools (http://cx-oracletools.sourceforge.net) and the modules in the cx_PyOracleLib (http://cx-pyoraclelib.sourceforge.net) projects. -For further information see - -http://cx-oracle.readthedocs.io -