gludb 0.1.0a1

Generalized Learning Utilities Database Library

For more GLU, see also [SuperGLU](https://github.com/GeneralizedLearningUtilities/SuperGLU)

GLUDB is meant to provide a fairly simple way to read/write data to some popular datastores (like DynamoDB and Google Cloud Datastore). Depending on the data backend, we hope to provide:

• A simple abstraction layer for annotating classes that should be stored in the database

• Support for versioning by automatically storing change history when possible

• A lightweight permissions module for handling authenticated read and write

• Limited query support

• Automated, configurable backup scheduling

To claim version 1.0 status, we will need to implement backend adaptors for: * DynamoDB * Google Cloud Datastore * MongoDB

We are currently planning on supporting both Python 2 (2.7+) and Python 3 (3.4+). However, please keep in mind that we will be emphasizing Python 3 going forward.

Testing

Please see tests/README.md for details.

Top-level directory contents

Some can find the top-level directory for a new project a little overwhelming. Here’s a complete breakdown of what you can expect to see here (in alphabetical order):

• .gitignore - This lists files that will be automatically ignored by git

• .travis.yml - The configuration file use by Travis CI (our continuous integration provider)

• build - Created when you use ./build.sh (in .gitignore)

• build.sh - A script to build distributions of the gludb library suitable for use by others (and upload to PyPI)

• dev-requirements.txt - Requirements to be installed into a virtualenv used for development on gludb. Mainly used by our testing scripts

• dist - Holds the final output of the ./build.sh command (in .gitignore)

• docs - Our documentation in mkdocs format (which is one of the two formats used by ReadTheDocs.org)

• gludb - Our actual package info

• gludb.egg-info - Created as part of a process developing the gludb package

• LICENSE - The license under which the contents of this repository are placed

• mkdocs.yml - The configuration file for the documentation in the docs directory

• README.md - This file

• setup.cfg - Parameters used by setup.py

• setup.py - The main setup file for the gludb package - used by ./build.sh and other sources for install, remove, etc

• tests - Location for our unit tests