Dry ORM
=======
Dry ORM is inspired by Django-ORM.
Dryorm provides basic functionality on top of your models:
* Easily Instantiate objects mapping tables
* Get Instance by ID
* Update Instance on target database
* Follow instance changes to know what to save
* Avoid repeating code for fetching one/all elements
Install
=======
Using Pip
^^^^^^^^^
Run the command:
.. code-block:: bash
pip install dry-orm
Instaling from the source
^^^^^^^^^^^^^^^^^^^^^^^^^
You can clone the repository and install:
.. code-block:: bash
git clone https://github.com/jalpedrinha/dryorm.git
cd dryorm && python setup.py install
Compatibility
=============
Dry ORM currently works with python2.7+
Supports postgresql and sqlite3.
Getting Started
===============
Soon...
Documentation
=============
Gently hosted by `ReadTheDocs <http://www.readthedocs.org/>`_ @ `Docs <http://dryorm.readthedocs.org/en/latest>`_ .
About DRY-ORM
==============
Dry ORM is a simple way to access database objects with the least possible code.
It's not supposed to be swiss army knife, but to simplify small tasks.
License
=======
The BSD 3-Clause License
^^^^^^^^^^^^^^^^^^^^^^^^
Copyright (c) 2015, Jorge Alpedrinha Ramos
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
* Neither the name of the organization nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
