python-oracledb 1.0.0 has been released!

anthony-tuininga · anthony-tuininga · commit fde577bf1fb1 · 2022-05-25T14:43:26.000-06:00
diff --git a/README.md b/README.md
@@ -1,4 +1,18 @@
-# cx_Oracle version 8.3
+# Python cx_Oracle
+
+# News
+
+**cx_Oracle has a major new release under a new name and homepage
+[python-oracledb](https://oracle.github.io/python-oracledb/).**
+
+**The source code has moved to
+[github.com/oracle/python-oracledb](https://github.com/oracle/python-oracledb).**
+
+New projects should install python-oracledb instead of cx_Oracle.  Critical
+patches and binary packages for new Python releases may continue to be made in
+the cx_Oracle namespace for a limited time, subject to demand.
+
+# About
 
 cx_Oracle is a Python extension module that enables access to Oracle
 Database.  It conforms to the [Python database API 2.0
@@ -7,7 +21,7 @@ of exclusions.  See the
 [homepage](https://oracle.github.io/python-cx_Oracle/index.html) for a
 feature list.
 
-cx_Oracle 8.3 has been tested with Python versions 3.6 through 3.10. You can
+cx_Oracle 8.3 was tested with Python versions 3.6 through 3.10. You can
 use cx_Oracle with Oracle 11.2, 12c, 18c, 19c and 21c client libraries.
 Oracle's standard client-server version interoperability allows connection to
 both older and newer databases. For example Oracle 19c client libraries can
@@ -45,10 +59,10 @@ See [CONTRIBUTING](https://github.com/oracle/python-cx_Oracle/blob/main/CONTRIBU
 
 cx_Oracle is licensed under a BSD license which you can find [here][3].
 
-[1]: https://www.python.org/dev/peps/pep-0249
-[2]: http://cx-oracle.readthedocs.io
+[1]: https://peps.python.org/pep-0249/
+[2]: https://cx-oracle.readthedocs.io
 [3]: https://github.com/oracle/python-cx_Oracle/blob/main/LICENSE.txt
-[5]: http://lists.sourceforge.net/lists/listinfo/cx-oracle-users
+[5]: https://sourceforge.net/projects/cx-oracle/lists/cx-oracle-users
 [6]: https://github.com/oracle/python-cx_Oracle/tree/main/samples/tutorial
 [7]: http://cx-oracletools.sourceforge.net
 [8]: http://cx-pyoraclelib.sourceforge.net
diff --git a/README.txt b/README.txt
@@ -1,5 +1,7 @@
-Please see the cx_Oracle home page for links to documentation, source, build
-and installation instructions:
+An enhanced cx_Oracle release is now under the python-oracledb namespace.  See
+https://oracle.github.io/python-oracledb/index.html for how to install and use
+this updated driver.
 
+For information about cx_Oracle itself, see
 https://oracle.github.io/python-cx_Oracle/index.html
 
diff --git a/doc/src/api_manual/module.rst b/doc/src/api_manual/module.rst
@@ -6,6 +6,13 @@
 Module Interface
 ****************
 
+.. note::
+
+    **cx_Oracle has a major new release under a new name and homepage**
+    `python-oracledb <https://oracle.github.io/python-oracledb/>`__.
+
+    **New projects should install python-oracledb instead of cx_Oracle.**
+
 .. data:: __future__
 
     Special object which contains attributes which control the behavior of
diff --git a/doc/src/index.rst b/doc/src/index.rst
@@ -11,6 +11,13 @@ releases.
 (the BSD license). A detailed description of cx_Oracle changes can be found in
 the :ref:`release notes <releasenotes>`.
 
+.. note::
+
+    **cx_Oracle has a major new release under a new name and homepage**
+    `python-oracledb <https://oracle.github.io/python-oracledb/>`__.
+
+    **New projects should install python-oracledb instead of cx_Oracle.**
+
 Contents:
 
 User Guide
diff --git a/doc/src/user_guide/installation.rst b/doc/src/user_guide/installation.rst
@@ -4,12 +4,19 @@
 cx_Oracle 8 Installation
 ************************
 
+.. note::
+
+    **cx_Oracle has a major new release under a new name and homepage**
+    `python-oracledb <https://oracle.github.io/python-oracledb/>`__.
+
+    **New projects should install python-oracledb instead of cx_Oracle.**
+
 Overview
 ========
 
-To use cx_Oracle 8 with Python and Oracle Database you need:
+To use cx_Oracle 8.3 with Python and Oracle Database you need:
 
-- Python 3.5 and higher. Older versions of cx_Oracle may work with older
+- Python 3.6 and higher. Older versions of cx_Oracle may work with older
   versions of Python.
 
 - Oracle Client libraries. These can be from the free `Oracle Instant Client
@@ -35,18 +42,12 @@ product: it is how the Oracle Client and Oracle Database communicate.
 Quick Start cx_Oracle Installation
 ==================================
 
-The `Quick Start: Developing Python Applications for Oracle Database
-<https://www.oracle.com/database/technologies/appdev/python/quickstartpythononprem.html>`__
-and `Quick Start: Developing Python Applications for Oracle Autonomous Database
-<https://www.oracle.com/database/technologies/appdev/python/quickstartpython.html>`__
-instructions have steps for Windows, Linux, and macOS.
-
-Alternatively you can:
+You can:
 
 - Install `Python <https://www.python.org/downloads>`__ 3, if not already
   available.  On macOS you must always install your own Python.
 
-  Python 3.5 and higher are supported by cx_Oracle 8.  If you use Python 2,
+  Python 3.6 and higher are supported by cx_Oracle 8.3.  If you use Python 2,
   then the older cx_Oracle 7.3 will install.
 
 - Install cx_Oracle from `PyPI
@@ -191,6 +192,13 @@ Installing cx_Oracle on Linux
 This section discusses the generic installation methods on Linux.  To use Python
 and cx_Oracle RPM packages from yum on Oracle Linux, see :ref:`oraclelinux`.
 
+.. note::
+
+    **cx_Oracle has a major new release under a new name and homepage**
+    `python-oracledb <https://oracle.github.io/python-oracledb/>`__.
+
+    **New projects should install python-oracledb instead of cx_Oracle.**
+
 Install cx_Oracle
 -----------------
 
@@ -424,6 +432,13 @@ Developers <https://yum.oracle.com/oracle-linux-python.html>`__.
 Installing cx_Oracle on Windows
 ===============================
 
+.. note::
+
+    **cx_Oracle has a major new release under a new name and homepage**
+    `python-oracledb <https://oracle.github.io/python-oracledb/>`__.
+
+    **New projects should install python-oracledb instead of cx_Oracle.**
+
 Install cx_Oracle
 -----------------
 
@@ -572,6 +587,13 @@ Python architecture.
 Installing cx_Oracle on macOS (Intel x86)
 =========================================
 
+.. note::
+
+    **cx_Oracle has a major new release under a new name and homepage**
+    `python-oracledb <https://oracle.github.io/python-oracledb/>`__.
+
+    **New projects should install python-oracledb instead of cx_Oracle.**
+
 Install Python
 --------------
 
diff --git a/doc/src/user_guide/introduction.rst b/doc/src/user_guide/introduction.rst
@@ -9,6 +9,13 @@ Database.  It conforms to the `Python Database API v2.0 Specification
 <https://www.python.org/dev/peps/pep-0249/>`__ with a considerable number of
 additions and a couple of exclusions.
 
+.. note::
+
+    **cx_Oracle has a major new release under a new name and homepage**
+    `python-oracledb <https://oracle.github.io/python-oracledb/>`__.
+
+    **New projects should install python-oracledb instead of cx_Oracle.**
+
 Architecture
 ------------
 
@@ -131,12 +138,6 @@ The output is::
 Examples and Tutorials
 ----------------------
 
-The `Quick Start: Developing Python Applications for Oracle Database
-<https://www.oracle.com/database/technologies/appdev/python/quickstartpythononprem.html>`__
-and `Quick Start: Developing Python Applications for Oracle Autonomous Database
-<https://www.oracle.com/database/technologies/appdev/python/quickstartpython.html>`__
-instructions have steps for Windows, Linux, and macOS.
-
 Runnable examples are in the `GitHub samples directory
 <https://github.com/oracle/python-cx_Oracle/tree/main/samples>`__.  A `Python
 cx_Oracle tutorial
diff --git a/samples/README.md b/samples/README.md
@@ -1,4 +1,16 @@
-# cx_Oracle Examples
+# Samples
+
+## News
+
+**cx_Oracle has a major new release under a new name and homepage
+[python-oracledb](https://oracle.github.io/python-oracledb/).**
+
+**New projects should install python-oracledb instead of cx_Oracle.**
+
+**The new source code and samples can be found at
+[github.com/oracle/python-oracledb](https://github.com/oracle/python-oracledb).**
+
+## cx_Oracle Examples
 
 This directory contains samples for [cx_Oracle][6].  Documentation is
 [here][7].  A separate tutorial is [here][8].
