Package: plib3.dbtools
The PLIB3.DBTOOLS package provides an easier to use interface
to DB-API compliant databases. The latest official release is
available on PyPI athttps://pypi.org/project/plib3.dbtools/and the latest source code is available on Gitlab athttps://gitlab.com/pdonis/plib3-dbtools.PLIB3.DBTOOLS is built using thebuildPEP 517 build tool
with thesetuputils_buildbackend, which uses thesetuputilshelper module to build the setup.cfg file that
is included with the distribution. This module and build backend
are available athttps://gitlab.com/pdonis/setuputils3.The PLIB3.DBTOOLS PackageThe following classes and functions are available in theplib.dbtoolsnamespace:TheDBInterfaceclass 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.TheMySQLDBInterfaceclass customizesDBInterfaceto work
with a MySQL database. It uses theMySQLdbthird-party Python
package. This class is in theplib.dbtools.mysqlsub-package.TheSQLite3DBInterfaceclass customizesDBInterfaceto work
with an SQLite version 3 database. It uses thesqlite3module
that comes with Python as its database engine. This class is in theplib.dbtools.sqlitesub-package.Theget_db_interfacefunction is a convenience function that
returns an instance of the appropriateDBInterfacesubclass for
the database type passed to it.Theget_db_interface_classandget_db_interface_argsfunctions
factor out key portions ofget_db_interfaceso that they can be
used separately if desired. For example, some databases might require
subclassing the interface class further, or customizing the interface
arguments.InstallationThe simplest way to install PLIB3.DBTOOLS is by usingpip:$ python3 -m pip install plib3.dbtoolsThis will download the latest release from PyPI and install it
on your system. If you already have a downloaded source tarball or
wheel, you can havepipinstall it directly by giving its
filename in place of “plib3.dbtools” in the above command line.The Zen of PLIB3There is no single unifying purpose or theme to PLIB3, but
like Python itself, it does have a ‘Zen’ of sorts:Express everything possible in terms of built-in Python
data structures.Once you’ve expressed it that way, what the code is
going to do with it should be obvious.Avoid boilerplate code,andboilerplate data. Every
piece of data your program needs should have one and
only one source.Copyright and LicensePLIB3.DBTOOLS is Copyright (C) 2008-2022 by Peter A. Donis.This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version. (See the LICENSE.txt file for a
copy of version 2 of the License.)This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.