Metadata-Version: 2.0
Name: gludb
Version: 0.1.2
Summary: A simple database wrapper
Home-page: https://github.com/memphis-iis/GLUDB
Author: University of Memphis Institute for Intelligent Systems
Author-email: cnkelly@memphis.edu
License: Apache Version 2.0
Keywords: database versioning backupsqlite dynamodb cloud datastore mongodb
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Topic :: Database
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: System :: Archiving :: Backup
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.2
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Requires-Dist: json-delta (>=1.1.3)
Provides-Extra: backups
Requires-Dist: boto; extra == 'backups'
Provides-Extra: dev
Provides-Extra: dynamodb
Requires-Dist: boto; extra == 'dynamodb'
Provides-Extra: gcd
Requires-Dist: googledatastore; extra == 'gcd'
Provides-Extra: mongodb
Requires-Dist: pymongo; extra == 'mongodb'
Provides-Extra: test
Requires-Dist: coverage; extra == 'test'
Requires-Dist: nose; extra == 'test'
Requires-Dist: tornado; extra == 'test'

GLUDB
=====

|Travis CI Build State| `Travis CI
Details <https://travis-ci.org/memphis-iis/GLUDB>`__

|Documentation State| See our documentation at
http://gludb.readthedocs.org/

Generalized Learning Utilities Database Library
-----------------------------------------------

For more GLU, see also
`SuperGLU <https://github.com/GeneralizedLearningUtilities/SuperGLU>`__

GLUDB provides a fairly simple way to read/write data to some popular
datastores like Amazon's DynamoDB and Google Cloud Datastore. We
provide:

-  A simple abstraction layer for annotating classes that should be
   stored in the database
-  Support for versioning by automatically storing change history with
   the data
-  Automated "indexing", which includes querying on the value of indexes
-  Automated, configurable backup to Amazon's S3 (and Glacier depending
   on how you configure the S3 buckets)

We currently support Python 2 (2.7 and greater) and 3 (3.4 and greater).
The data stores currently supported are:

-  sqlite
-  DynamoDB
-  Google Cloud Datastore
-  MongoDB

Installing
----------

You can install from PyPI using pip:

::

    pip install gludb

You will also need to install any dependencies you need based on the
functionality you want to use:

-  DynamoDB Backend - boto
-  Google Cloud Datastore - googledatastore
-  MongoDB - pymongo
-  Backups - boto

These dependencies are included in setup.py so that you can install them
all at the same time (assuming a fairly recent version of pip). As an
example, you could install gludb and the dependencies needed for
dynamodb and backup support into a virtualenv using Python 3 like this:

::

    user@host:~$ virtualenv -p python3 env
    user@host:~$ . env/bin/activate
    user@host:~$ pip install --upgrade pip wheel
    user@host:~$ pip install gludb[dynamodb,backups]

.. |Travis CI Build State| image:: https://travis-ci.org/memphis-iis/GLUDB.svg?branch=master
.. |Documentation State| image:: https://img.shields.io/badge/docs-latest-brightgreen.svg?style=flat


