corral-pipeline 0.3

MVC framework for create trustworthy pipelines

.. image:: docs/source/_static/logo_medium.jpg
:align: left
:scale: 50%
:alt: Corral


The Powerful Pipeline Framework
===============================

.. image:: https://travis-ci.org/toros-astro/corral.svg?branch=master
:target: https://travis-ci.org/toros-astro/corral
:alt: Build Status

.. image:: https://img.shields.io/badge/License-BSD%203--Clause-blue.svg
:target: https://opensource.org/licenses/BSD-3-Clause
:alt: License

.. image:: https://img.shields.io/badge/python-2.7-blue.svg
:target: https://badge.fury.io/py/corral-pipeline
:alt: py27

.. image:: https://img.shields.io/badge/python-3.4-blue.svg
:target: https://badge.fury.io/py/corral-pipeline
:alt: py34

.. image:: https://img.shields.io/badge/python-3.5-blue.svg
:target: https://badge.fury.io/py/corral-pipeline
:alt: py3.5

.. image:: https://badge.fury.io/py/corral-pipeline.svg
:target: https://badge.fury.io/py/corral-pipeline
:alt: Pypi Package

.. image:: https://img.shields.io/badge/docs-latest-brightgreen.svg?style=flat
:target: http://corral.readthedocs.io/en/latest/
:alt: Documentation Status

Corral will solve your pipeline needs by merging a database full connection
interface with a MVC model, by making you able of editing your custom schemas
and adding the possibility of writting specific processing steps following a
intuitive data handling model.


Features
--------

* Command line interface with standard utilities
* Editable commands on your application
* Completely built on SQLAlchemy ORM
* Allows the introduction of Steps
* Follows the MVC (Model View Controller) pattern


Support
-------

- **Full Documentation and Tutorial:** http://corral.readthedocs.io/
- **Community Forum:**
https://groups.google.com/forum/#!forum/corral-users-forum
- **Issues:** If you have issues please report them as a issue
here: https://github.com/toros-astro/corral/issues


User Installation
-----------------

The easiest way to install corral is using pip

.. code-block:: bash

$ pip install -U corral-pipeline


Developmment
------------

Install project by cloning from `Corral github <https://github.com/toros-astro/corral.git>`__:

.. code-block:: bash

$ git clone https://github.com/toros-astro/corral.git

and by making ``pip install -e .``, or the classic ``python setup.py install``.

You can also run the install by giving the github link directly to pip:

.. code-block:: bash

$ pip install -e git+https://github.com/toros-astro/corral.git


License
-------

- BSD-3: https://opensource.org/licenses/BSD-3-Clause
- BSD-3 Licence Explained: https://tldrlegal.com/license/bsd-3-clause-license-(revised)