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 for basic functionality: ``simplejson``,
``jsonschema``, ``termcolor``, and ``tabulate``. With this, you’ll be
able to validate and run your tools through Boutiques. For full
functionality, you can install the library as follows:
::
$ pip install boutiques[all]
This will add some more dependencies, and let you use all of the
features: ``requests``, ``pytest``, ``termcolor``, ``oyaml``,
``tabulate`` and ``mock``. Now you’ll also be able to search for tools
and publish your own and records from when you ran your tool!
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"
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!
Examples
--------
We have a
`simple <https://github.com/boutiques/boutiques/tree/master/boutiques/schema/examples/example3>`__
and a
`complex <https://github.com/boutiques/boutiques/tree/master/boutiques/schema/examples/example1>`__
Boutiques descriptor to help you get started with your own descriptor.
.. |Codacy Badge| image:: https://api.codacy.com/project/badge/Grade/52fc5590446c4d1eb6626302b491ac3d
:target: https://app.codacy.com/gh/boutiques/boutiques?utm_source=github.com&utm_medium=referral&utm_content=boutiques/boutiques&utm_campaign=Badge_Grade_Settings
.. |DOI| image:: https://zenodo.org/badge/32616811.svg
:target: https://zenodo.org/badge/latestdoi/32616811
.. |PyPI| image:: https://img.shields.io/pypi/v/boutiques.svg
:target: https://pypi.python.org/pypi/boutiques
.. |image1| image:: https://img.shields.io/pypi/pyversions/boutiques.svg
:target: https://pypi.python.org/pypi/boutiques
.. |Build Status| image:: https://travis-ci.org/boutiques/boutiques.svg?branch=develop
:target: https://travis-ci.org/boutiques/boutiques
.. |Coverage Status| image:: https://coveralls.io/repos/github/boutiques/boutiques/badge.svg?branch=develop
:target: https://coveralls.io/github/boutiques/boutiques?branch=develop
Raw data
{
"_id": null,
"home_page": "http://github.com/boutiques/boutiques",
"name": "boutiques",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "Tristan Glatard, Gregory Kiar",
"author_email": "tristan.glatard@concordia.ca, gkiar07@gmail.com",
"download_url": "",
"platform": null,
"description": "Boutiques\n=========\n\n-.. image:: https://zenodo.org/badge/32616811.svg\n- :target: https://zenodo.org/badge/latestdoi/32616811\n-.. image:: https://img.shields.io/pypi/v/boutiques.svg\n- :target: https://pypi.python.org/pypi/boutiques\n-.. image:: https://img.shields.io/pypi/pyversions/boutiques.svg\n- :target: https://pypi.python.org/pypi/boutiques\n-.. image:: https://travis-ci.org/boutiques/boutiques.svg?branch=develop \n- :target: https://travis-ci.org/boutiques/boutiques\n-.. image:: https://coveralls.io/repos/github/boutiques/boutiques/badge.svg?branch=develop\n- :target: https://coveralls.io/github/boutiques/boutiques?branch=develop\n\nBoutiques is a cross-platform descriptive command-line framework for\napplications.\n\nThe Power of Boutiques Tools\n----------------------------\n\nBoutiques is a framework to make data analysis tools Findable Accessible\nInteroperable and Reusable (FAIR). An overview of the framework and its\ncapabilities is available\n`here <https://figshare.com/articles/fair-pipelines-poster_pdf/8143241>`__,\nand a more complete description is\n`here <https://academic.oup.com/gigascience/article/7/5/giy016/4951979>`__.\n\nInstallation\n------------\n\nSimple! Just open your favourite terminal and type:\n\n::\n\n $ pip install boutiques\n\nAlongside installing the Boutiques package, this will also ensure the\ndependencies are installed for basic functionality: ``simplejson``,\n``jsonschema``, ``termcolor``, and ``tabulate``. With this, you\u2019ll be\nable to validate and run your tools through Boutiques. For full\nfunctionality, you can install the library as follows:\n\n::\n\n $ pip install boutiques[all]\n\nThis will add some more dependencies, and let you use all of the\nfeatures: ``requests``, ``pytest``, ``termcolor``, ``oyaml``,\n``tabulate`` and ``mock``. Now you\u2019ll also be able to search for tools\nand publish your own and records from when you ran your tool!\n\nIf you want the latest changes that aren\u2019t officially released yet, you\ncan also install directly from GitHub:\n\n::\n\n $ pip install \"git+https://github.com/boutiques/boutiques@develop#egg=boutiques\"\n\nTutorial\n--------\n\nOur\n`tutorial <https://nbviewer.jupyter.org/github/boutiques/tutorial/blob/master/notebooks/boutiques-tutorial.ipynb>`__\nwill introduce you to the main Boutiques features through its command\nline and Python APIs. Give it a try!\n\nContributing\n------------\n\nExcited by the project and want to get involved?! *Please* check out our\n`contributing guide <./CONTRIBUTING.md>`__, and look through the\n`issues <https://github.com/boutiques/boutiques/issues/>`__ (in\nparticular, those tagged with \u201c`good first\nissue <https://github.com/boutiques/boutiques/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22>`__\u201d)\nto start seeing where you can lend a hand. We look forward to approving\nyour amazing contributions!\n\nExamples\n--------\n\nWe have a\n`simple <https://github.com/boutiques/boutiques/tree/master/boutiques/schema/examples/example3>`__\nand a\n`complex <https://github.com/boutiques/boutiques/tree/master/boutiques/schema/examples/example1>`__\nBoutiques descriptor to help you get started with your own descriptor.\n\n.. |Codacy Badge| image:: https://api.codacy.com/project/badge/Grade/52fc5590446c4d1eb6626302b491ac3d\n :target: https://app.codacy.com/gh/boutiques/boutiques?utm_source=github.com&utm_medium=referral&utm_content=boutiques/boutiques&utm_campaign=Badge_Grade_Settings\n.. |DOI| image:: https://zenodo.org/badge/32616811.svg\n :target: https://zenodo.org/badge/latestdoi/32616811\n.. |PyPI| image:: https://img.shields.io/pypi/v/boutiques.svg\n :target: https://pypi.python.org/pypi/boutiques\n.. |image1| image:: https://img.shields.io/pypi/pyversions/boutiques.svg\n :target: https://pypi.python.org/pypi/boutiques\n.. |Build Status| image:: https://travis-ci.org/boutiques/boutiques.svg?branch=develop\n :target: https://travis-ci.org/boutiques/boutiques\n.. |Coverage Status| image:: https://coveralls.io/repos/github/boutiques/boutiques/badge.svg?branch=develop\n :target: https://coveralls.io/github/boutiques/boutiques?branch=develop\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Schema for describing bash command-line tools",
"version": "0.5.26",
"project_urls": {
"Homepage": "http://github.com/boutiques/boutiques"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ac9920574dc0d26433cb779e1111067421ed8dd996eb9d3657bd14ddfb8553a8",
"md5": "8c611b0381ab5e2c63440c2eddce4fe7",
"sha256": "76f15b6a9449cba5c8164d64c1641bfb7ab0f1a7010501110d109c7c09fee8cb"
},
"downloads": -1,
"filename": "boutiques-0.5.26-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "8c611b0381ab5e2c63440c2eddce4fe7",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 112673,
"upload_time": "2023-11-23T02:41:27",
"upload_time_iso_8601": "2023-11-23T02:41:27.828365Z",
"url": "https://files.pythonhosted.org/packages/ac/99/20574dc0d26433cb779e1111067421ed8dd996eb9d3657bd14ddfb8553a8/boutiques-0.5.26-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-23 02:41:27",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "boutiques",
"github_project": "boutiques",
"travis_ci": true,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "boutiques"
}
JSON
