Metadata-Version: 1.1
Name: plib3.dbtools
Version: 1.1
Summary: Python 3 database interface tools.
Home-page: http://pypi.org/project/plib3.dbtools
Author: Peter A. Donis
Author-email: peterdonis@alum.mit.edu
License: UNKNOWN
Description: The PLIB3.DBTOOLS package provides an easier to use interface
        to DB-API compliant databases.
        
        Note: PLIB3.DBTOOLS works with Python 3. If you are using Python
        2.7, see the PLIB.DBTOOLS package, available at
        https://pypi.org/project/plib.dbtools.
        
        The ``setup.py`` script for PLIB3.DBTOOLS uses the ``setuputils``
        helper module, which helps to automate away much of the
        boilerplate in Python 3 setup scripts. This module is available
        as a separate release at https://pypi.org/project/setuputils3.
        
        The PLIB3.DBTOOLS Package
        -------------------------
        
        The following classes and functions are available in the ``plib.dbtools``
        namespace:
        
        - The ``DBInterface`` class provides a simple API for working with
          databases. It assumes that the underlying database engine conforms
          to the Python DB API. This class itself does not know about any
          particular database engine; a customized class should be derived
          from it for each particular engine.
        
        - The ``MySQLDBInterface`` class customizes ``DBInterface`` to work
          with a MySQL database. It uses the ``MySQLdb`` third-party Python
          package. This class is in the ``plib.dbtools.mysql`` sub-package.
        
        - The ``SQLite3DBInterface`` class customizes ``DBInterface`` to work
          with an SQLite version 3 database. It uses the ``sqlite3`` module
          that comes with Python as its database engine. This class is in the
          ``plib.dbtools.sqlite`` sub-package.
        
        - The ``get_db_interface`` function is a convenience function that
          returns an instance of the appropriate ``DBInterface`` subclass for
          the database type passed to it.
        
        - The ``get_db_interface_class`` and ``get_db_interface_args`` functions
          factor out key portions of ``get_db_interface`` so that they can be
          used separately if desired. For example, some databases might require
          subclassing the interface class further, or customizing the interface
          arguments.
        
        Installation
        ------------
        
        To install PLIB3.DBTOOLS, you can simply run::
        
            $ python3 setup.py install
        
        at a shell prompt from the directory into which you
        unzipped the source tarball (the same directory that this
        README file is in). This will install PLIB3 and then
        run each of the post-install scripts in the scripts
        directory.
        
        
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Environment :: MacOS X
Classifier: Environment :: Win32 (MS Windows)
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU General Public License v2 (GPLv2)
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Software Development :: Libraries :: Python Modules
