doqu / README

Doqu
====

`Doqu` is a lightweight schema/query framework for document databases.
It is not an ORM as it doesn't map existing schemata to Python objects but
instead defines them on a higher layer built upon a schema-less storage
(key/value or document-oriented). You define models as a valuable subset of the
whole database and work with only certain parts of existing entities —  the
parts that you need.

The name "doqu" is a shortcut for *document-query*, the central concept
of the library.

Installation
------------

Using pip:

    $ pip install doqu

ArchLinux (AUR):

    $ yaourt python2-doqu

Documentation
-------------

See the `complete documentation`_ for details. If it's not complete enough,
feel free to ask your questions in the `discussion group`_.

.. _complete documentation: http://packages.python.org/doqu
.. _discussion group: http://groups.google.com/group/doqu-users

Author
------

Originally written by Andrey Mikhaylenko since 2009.

See the file AUTHORS for a complete authors list of this application.

Please feel free to submit patches, report bugs or request features:

    http://bitbucket.org/neithere/doqu/issues/

Licensing
---------

Docu is free software: you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published
by the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

Docu 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 Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License
along with Docu.  If not, see <http://gnu.org/licenses/>.
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.