Metadata-Version: 2.1
Name: boutiques
Version: 0.5.24
Summary: Schema for describing bash command-line tools
Home-page: http://github.com/boutiques/boutiques
Author: Tristan Glatard, Gregory Kiar
Author-email: tristan.glatard@concordia.ca, gkiar07@gmail.com
License: MIT
Platform: UNKNOWN
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: License :: OSI Approved :: MIT License
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Operating System :: OS Independent
Classifier: Natural Language :: English
Requires-Dist: simplejson
Requires-Dist: requests
Requires-Dist: pytest
Requires-Dist: termcolor
Requires-Dist: pyyaml
Requires-Dist: jsonschema
Requires-Dist: tabulate
Requires-Dist: mock
Requires-Dist: docopt
Requires-Dist: nexus-sdk

Boutiques
=========

-.. image:: https://zenodo.org/badge/32616811.svg
-    :target: https://zenodo.org/badge/latestdoi/32616811
-.. image:: https://img.shields.io/pypi/v/boutiques.svg
-    :target: https://pypi.python.org/pypi/boutiques
-.. image:: https://img.shields.io/pypi/pyversions/boutiques.svg
-    :target: https://pypi.python.org/pypi/boutiques
-.. image:: https://travis-ci.org/boutiques/boutiques.svg?branch=develop 
-    :target: https://travis-ci.org/boutiques/boutiques
-.. image:: https://coveralls.io/repos/github/boutiques/boutiques/badge.svg?branch=develop
-    :target: https://coveralls.io/github/boutiques/boutiques?branch=develop

Boutiques is a cross-platform descriptive command-line framework for
applications.

The Power of Boutiques Tools
============================

Boutiques is a framework to make data analysis tools Findable Accessible
Interoperable and Reusable (FAIR). An overview of the framework and its
capabilities is available
`here <https://figshare.com/articles/fair-pipelines-poster_pdf/8143241>`__,
and a more complete description is
`here <https://academic.oup.com/gigascience/article/7/5/giy016/4951979>`__.

Installation
============

Simple! Just open your favourite terminal and type:

::

   $ pip install boutiques

Alongside installing the Boutiques package, this will also ensure the
dependencies are installed: ``simplejson``, ``jsonschema``,
``requests``, ``pytest``, ``termcolor``, ``pyyaml``, ``tabulate`` and
``mock``.

If you want the latest changes that aren’t officially released yet, you
can also install directly from GitHub:

::

   $ pip install "git+https://github.com/boutiques/boutiques@develop#egg=boutiques&subdirectory=tools/python"

Tutorial
========

Our
`tutorial <https://nbviewer.jupyter.org/github/boutiques/tutorial/blob/master/notebooks/boutiques-tutorial.ipynb>`__
will introduce you to the main Boutiques features through its command
line and Python APIs. Give it a try!

Contributing
============

Excited by the project and want to get involved?! *Please* check out our
`contributing guide <./CONTRIBUTING.md>`__, and look through the
`issues <https://github.com/boutiques/boutiques/issues/>`__ (in
particular, those tagged with “`good first
issue <https://github.com/boutiques/boutiques/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22>`__”)
to start seeing where you can lend a hand. We look forward to approving
your amazing contributions!


