Merge pull request #3 from Embarcadero/rename

Renaming entire package from idb to interbase

Author: lmbelo

PKG-INFO

@@ -6,7 +6,7 @@ Home-page: https://github.com/Embarcadero/InterBasePython
 Author: 
 Author-email:
 License: BSD
-Description: idb package is a set of InterBase RDBMS bindings for python.
+Description: interbase package is a set of InterBase RDBMS bindings for python.
              It works on Python 3.x.
 
 Keywords: InterBase

README.md

@@ -1,7 +1,7 @@
 # InterBase Driver for Python, supporting 32-bit and 64-bit
 
 [InterBase Documentation](https://docwiki.embarcadero.com/InterBase/2020/en/Main_Page) \* 
-[IDB Source](https://github.com/Embarcadero/InterBasePython) \* 
+[InterBase Source](https://github.com/Embarcadero/InterBasePython) \* 
 [Based On FDB](http://www.firebirdsql.org/en/devel-python-driver/)
 
 Changes implemented are based on this blog post

docs/.buildinfo

@@ -1,4 +1,4 @@
-# Sphinx build info version 1
-# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: d7c472b8db41b0381968dec2dc2ba872
-tags: 645f666f9bcd5a90fca523b33c5a78b7
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: 6a2af01995ecb4a6bfe4433df65e503d
+tags: 645f666f9bcd5a90fca523b33c5a78b7

docs/_sources/getting-started.txt

@@ -1,33 +1,33 @@
 
-########################
-Getting Started with IDB
-########################
+##############################
+Getting Started with Interbase
+##############################
 
 Installation
 ************
 
-IDB is written as pure-Python module on top of InterBase client library (gds.so/dylib and gds32/ibclient64.dll) using ctypes_,
-so *make sure you have InterBase client properly installed before you try to install IDB*, otherwise the 
-installation will fail. IDB supports InterBase 2020 and higher.
+Interbase is written as pure-Python module on top of InterBase client library (gds.so/dylib and gds32/ibclient64.dll) using ctypes_,
+so *make sure you have InterBase client properly installed before you try to install Interbase*, otherwise the 
+installation will fail. Interbase supports InterBase 2020 and higher.
 
-IDB is distributed as `setuptools`_ package, so you'll need setuptools or 
+Interbase is distributed as `setuptools`_ package, so you'll need setuptools or 
 `compatible package <http://pypi.python.org/pypi/distribute>`_ installed to
-install IDB properly.
+install Interbase properly.
 
 Installation using pip
 ========================
 
-  $ pip install git+ssh://[email protected]/Embarcadero/PythonInterBase.git
+  $ pip install git+ssh://[email protected]/Embarcadero/InterBasePython.git
 
 Installation from source
 ========================
 
 Download the source tarball, uncompress it, then run the install command::
 
-  $ git clone https://github.com/Embarcadero/PythonInterBase.git
+  $ git clone https://github.com/Embarcadero/InterBasePython.git
   $ python setup.py install
 
-.. _setuptools: https://github.com/Embarcadero/PythonInterBase
+.. _setuptools: https://github.com/Embarcadero/InterBasePython
 .. _PYPI: http://pypi.python.org
 .. _ctypes: http://docs.python.org/library/ctypes.html
 
@@ -36,11 +36,11 @@ Quick-start Guide
 *****************
 
 This brief tutorial aims to get the reader started by demonstrating
-elementary usage of IDB. It is not a comprehensive Python
+elementary usage of Interbase. It is not a comprehensive Python
 Database API tutorial, nor is it comprehensive in its coverage of
 anything else.
 
-The numerous advanced features of IDB are covered in another
+The numerous advanced features of Interbase are covered in another
 section of this documentation, which is not in a tutorial format, though it
 is replete with examples.
 
@@ -55,13 +55,13 @@ A database connection is typically established with code such as this:
 
 .. sourcecode:: python
 
-    import idb
+    import interbase
 
     # The server is named 'bison'; the database file is at '/temp/test.db'.
-    con = idb.connect(dsn='bison:/temp/test.db', user='sysdba', password='pass')
+    con = interbase.connect(dsn='bison:/temp/test.db', user='sysdba', password='pass')
 
     # Or, equivalently:
-    con = idb.connect(
+    con = interbase.connect(
         host='bison', database='/temp/test.db',
         user='sysdba', password='masterkey'
       )
@@ -74,9 +74,9 @@ UTF-8 as the character set of the connection:
 
 .. sourcecode:: python
 
-    import idb
+    import interbase
 
-    con = idb.connect(
+    con = interbase.connect(
         dsn='bison:/temp/test.db',
         user='sysdba', password='masterkey',
         charset='UTF8' # specify a character set for the connection
@@ -108,9 +108,9 @@ the `languages` table:
 
 .. sourcecode:: python
 
-    import idb
+    import interbase
 
-    con = idb.connect(dsn='bison:/temp/test.db', user='sysdba', password='masterkey')
+    con = interbase.connect(dsn='bison:/temp/test.db', user='sysdba', password='masterkey')
 
     # Create a Cursor object that operates in the context of Connection con:
     cur = con.cursor()
@@ -136,9 +136,9 @@ fetching a single row at a time from a `SELECT`-cursor:
 
 .. sourcecode:: python
 
-    import idb
+    import interbase
 
-    con = idb.connect(dsn='bison:/temp/test.db', user='sysdba', password='masterkey')
+    con = interbase.connect(dsn='bison:/temp/test.db', user='sysdba', password='masterkey')
 
     cur = con.cursor()
     SELECT = "select name, year_released from languages order by year_released"
@@ -179,19 +179,19 @@ example to `languages`):
 
 .. sourcecode:: python
 
-    import idb
+    import interbase
 
     TABLE_NAME = 'languages'
     SELECT = 'select * from %s order by year_released' % TABLE_NAME
 
-    con = idb.connect(dsn='bison:/temp/test.db', user='sysdba', password='masterkey')
+    con = interbase.connect(dsn='bison:/temp/test.db', user='sysdba', password='masterkey')
 
     cur = con.cursor()
     cur.execute(SELECT)
 
     # Print a header.
     for fieldDesc in cur.description:
-        print fieldDesc[idb.DESCRIPTION_NAME].ljust(fieldDesc[idb.DESCRIPTION_DISPLAY_SIZE]) ,
+        print fieldDesc[interbase.DESCRIPTION_NAME].ljust(fieldDesc[interbase.DESCRIPTION_DISPLAY_SIZE]) ,
     print # Finish the header with a newline.
     print '-' * 78
 
@@ -201,7 +201,7 @@ example to `languages`):
     for row in cur:
         for fieldIndex in fieldIndices:
             fieldValue = str(row[fieldIndex])
-            fieldMaxWidth = cur.description[fieldIndex][idb.DESCRIPTION_DISPLAY_SIZE]
+            fieldMaxWidth = cur.description[fieldIndex][interbase.DESCRIPTION_DISPLAY_SIZE]
 
             print fieldValue.ljust(fieldMaxWidth) ,
 
@@ -224,9 +224,9 @@ Let's insert more languages:
 
 .. sourcecode:: python
 
-    import idb
+    import interbase
 
-    con = idb.connect(dsn='bison:/temp/test.db', user='sysdba', password='masterkey')
+    con = interbase.connect(dsn='bison:/temp/test.db', user='sysdba', password='masterkey')
 
     cur = con.cursor()
 
@@ -281,7 +281,7 @@ retrieved from a stored procedure by `SELECT`ing from the procedure,
 whereas output parameters are retrieved with an `EXECUTE PROCEDURE`
 statement.
 add
-To *retrieve a result set* from a stored procedure with IDB,
+To *retrieve a result set* from a stored procedure with Interbase,
 use code such as this:
 
 .. sourcecode:: python

docs/_sources/index.txt

@@ -1,23 +1,23 @@
-.. IDB documentation master file, created by sphinx-quickstart on Wed Jan  7 12:29:48 2009.
+.. Interbase documentation master file, created by sphinx-quickstart on Wed Jan  7 12:29:48 2009.
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-###############################
-Welcome to IDB's documentation!
-###############################
+#####################################
+Welcome to Interbase's documentation!
+#####################################
 
-IDB is a `Python <http://python.org>`__ library package that
-implements `Python Database API 2.0`-compliant support for the open source relational
+Interbase is a `Python <http://python.org>`__ library package that
+implements `Python Database API 2.0`-compliant support for the relational
 database `InterBase® <https://www.embarcadero.com/products/interbase>`__.
 In addition to the minimal feature set of the standard Python DB API,
-IDB also exposes nearly the entire native client API of the database engine.
+Interbase also exposes nearly the entire native client API of the database engine.
 
-IDB is free -- covered by a permissive BSD-style `license
+Interbase is free -- covered by a permissive BSD-style `license
 <license.html>`__ that both commercial and noncommercial users should
 find agreeable.
 
 This documentation set is not a tutorial on Python, SQL, or InterBase;
-rather, it is a topical presentation of IDB's feature set,
+rather, it is a topical presentation of Interbase's feature set,
 with example code to demonstrate basic usage patterns. For detailed
 information about InterBase features, see the `InterBase documentation 
 <https://docwiki.embarcadero.com/InterBase/2020/en/Main_Page>`.