Skip to main content

Create a CLI to chain tasks as a pipeline

Project description

clichain

license python version build-status Documentation Status coverage pypi package

Create a command line interface to chain tasks as a pipeline

clichain is a framework to easily define task types and chain them from a command line interface.

The goal of this framework is to use David Beazle’s idea to implement task types as coroutines and use them to create and run a pipeline.

The goal is not to parallelize tasks but to be able to reuse task types in different configurations without need for coding and in some cases reuse a result from a long computational task for different purposes without running it several times.

install and test

install from pypi

using pip:

$ pip install clichain

install using requirements

There is a makefile in the project root directory:

$ make install

Using pip, the above is equivalent to:

$ pip install -r requirements.txt
$ pip install -e .

dev install

There is a makefile in the project root directory:

$ make dev

Using pip, the above is equivalent to:

$ pip install -r requirements-dev.txt
$ pip install -e .

run the tests

Use the makefile in the project root directory:

$ make test

This runs the tests generating a coverage html report

build the doc

The documentation is made with sphinx, you can use the makefile in the project root directory to build html doc:

$ make doc

Documentation

Documentation on Read The Docs.

Meta

loicpw - peronloic.us@gmail.com

Distributed under the MIT license. See LICENSE.txt for more information.

https://github.com/loicpw

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

clichain-0.1.1.tar.gz (20.3 kB view hashes)

Uploaded Source

Built Distribution

clichain-0.1.1-py2.py3-none-any.whl (22.5 kB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page