.. mincepy documentation master file, created by
   sphinx-quickstart on Fri Mar 31 17:03:20 2017.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

.. _mincePy: https://github.com/muhrin/mincepy
.. _object-relational mapper: https://en.wikipedia.org/wiki/Object-relational_mapping
.. _data mapper pattern: https://en.wikipedia.org/wiki/Data_mapper_pattern
.. _gui: https://github.com/muhrin/mincepy_gui/
.. _store: examples/quick-start.ipynb#Storing-objects
.. _find: examples/quick-start.ipynb#Finding-objects
.. _annotate: examples/quick-start.ipynb#Annotating-objects
.. _history: examples/quick-start.ipynb#Version-control


Welcome to mincePy's documentation!
===================================

.. image:: https://codecov.io/gh/muhrin/mincepy/branch/develop/graph/badge.svg
    :target: https://codecov.io/gh/muhrin/mincepy
    :alt: Coveralls

.. image:: https://travis-ci.org/muhrin/mincepy.svg
    :target: https://travis-ci.org/muhrin/mincepy
    :alt: Travis CI

.. image:: https://img.shields.io/pypi/v/mincepy.svg
    :target: https://pypi.python.org/pypi/mincepy/
    :alt: Latest Version

.. image:: https://img.shields.io/pypi/wheel/mincepy.svg
    :target: https://pypi.python.org/pypi/mincepy/

.. image:: https://img.shields.io/pypi/pyversions/mincepy.svg
    :target: https://pypi.python.org/pypi/mincepy/

.. image:: https://img.shields.io/pypi/l/mincepy.svg
    :target: https://pypi.python.org/pypi/mincepy/


`mincePy`_: move the database to one side and let your objects take centre stage.

MincePy is an `object-relational mapper`_ (ORM) using the `data mapper pattern`_ designed specifically for computational
and data science.  What does this all mean??  It's simple really, it means you can `store`_, `find`_, get the `history`_
of and `annotate`_ any of your python objects either in your local database or one shared with your collaborators.

Features
++++++++

* Ability to work locally or collaboratively on a shared database.
* Automatic tracking of in-memory objects.
* Easy addition of new python types.
* Object version control.
* Live references between objects.
* Optimistic locking.
* Python 3.5+ compatible.
* A responsive, Qt, `gui`_.


Installation
++++++++++++

Installation with pip:

.. code-block:: shell

    pip install mincepy


Installation from git:

.. code-block:: shell

    # via pip
    pip install https://github.com/muhrin/mincepy/archive/master.zip

    # manually
    git clone https://github.com/muhrin/mincepy.git
    cd mincepy
    python setup.py install


Next you'll need MongoDB, in Ubuntu it's as simple as:


.. code-block:: shell

    apt install mongodb

see `here <https://docs.mongodb.com/manual/administration/install-community/>`_, for other platforms.


Development
+++++++++++

Clone the project:

.. code-block:: shell

    git clone https://github.com/muhrin/mincepy.git
    cd mincepy


Create a new virtualenv for `mincePy`_:

.. code-block:: shell

    virtualenv -p python3 mincepy

Install all requirements for `mincePy`_:

.. code-block:: shell

    env/bin/pip install -e '.[dev]'

Table Of Contents
+++++++++++++++++

.. toctree::
   :glob:
   :maxdepth: 3

   examples/quick-start.ipynb
   storing-objects
   apidoc


Versioning
++++++++++

This software follows `Semantic Versioning`_


.. _Semantic Versioning: http://semver.org/