boutiques

A cross-platform descriptive command-line framework for applications

https://github.com/boutiques/boutiques

Science Score: 46.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
    Links to: zenodo.org
  • Committers with academic emails
    9 of 41 committers (22.0%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (18.2%) to scientific vocabulary

Keywords from Contributors

neuroimaging workflow-engine neuroinformatics brain-imaging
Last synced: 7 months ago · JSON representation

Repository

A cross-platform descriptive command-line framework for applications

Basic Info
  • Host: GitHub
  • Owner: boutiques
  • License: other
  • Language: Python
  • Default Branch: master
  • Homepage: http://boutiques.github.io
  • Size: 88.2 MB
Statistics
  • Stars: 63
  • Watchers: 15
  • Forks: 53
  • Open Issues: 94
  • Releases: 31
Created about 11 years ago · Last pushed 8 months ago
Metadata Files
Readme Contributing License

README.md

Boutiques logo

Boutiques

Codacy Badge DOI PyPI PyPI Build Status Coverage Status test

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, and a more complete description is here.

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 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, and look through the issues (in particular, those tagged with "good first issue") to start seeing where you can lend a hand. We look forward to approving your amazing contributions!

Examples

We have a simple and a complex Boutiques descriptor to help you get started with your own descriptor.

Owner

  • Name: boutiques
  • Login: boutiques
  • Kind: organization

GitHub Events

Total
  • Create event: 7
  • Release event: 4
  • Issues event: 15
  • Watch event: 5
  • Delete event: 5
  • Issue comment event: 49
  • Push event: 21
  • Pull request review event: 9
  • Pull request review comment event: 4
  • Pull request event: 49
  • Fork event: 5
Last Year
  • Create event: 7
  • Release event: 4
  • Issues event: 15
  • Watch event: 5
  • Delete event: 5
  • Issue comment event: 49
  • Push event: 21
  • Pull request review event: 9
  • Pull request review comment event: 4
  • Pull request event: 49
  • Fork event: 5

Committers

Last synced: over 2 years ago

All Time
  • Total Commits: 1,347
  • Total Committers: 41
  • Avg Commits per committer: 32.854
  • Development Distribution Score (DDS): 0.756
Past Year
  • Commits: 0
  • Committers: 0
  • Avg Commits per committer: 0.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Tristan Glatard t****d@c****a 328
darrinfong d****g@g****m 237
Greg Kiar g****7@g****m 200
Tristan Glatard t****d@m****a 123
Erin Benderoff e****f@g****m 112
sthiel s****l@g****m 92
Jérôme Charrière j****e@g****m 46
Tristan A.A t****g@m****a 43
Tristan Glatard t****d@c****r 32
joeyzhou98 j****2@g****m 19
Erin Benderoff e****f@l****n 18
Stuart Thiel S****l@R****a 12
Mathieu Dugré m****e@g****m 11
Valerie Hayot-Sasson v****t@g****m 8
Natacha Beck n****k@g****m 7
Unknown s****e@h****m 6
FriesenA a****n@p****m 6
Shawn Brown s****3@m****a 4
Arthur Masson a****w@g****m 4
Stuart Thiel s****l@g****m 4
Shawn Brown s****n@p****u 3
MontrealSergiy s****y@g****m 3
Jerry Jeyachandra j****a@m****a 3
Valerie Hayot-Sasson v****s@c****a 3
Jerry Jeyachandra j****a@g****m 2
xlecours x****r@m****a 2
Darrin Fong D****g 2
Stuart Thiel s****l@h****a 2
Natacha Beck n****k@m****a 2
Arthur Masson a****n@i****r 2
and 11 more...

Issues and Pull Requests

Last synced: 7 months ago

All Time
  • Total issues: 80
  • Total pull requests: 102
  • Average time to close issues: about 1 year
  • Average time to close pull requests: 2 months
  • Total issue authors: 29
  • Total pull request authors: 14
  • Average comments per issue: 1.65
  • Average comments per pull request: 1.35
  • Merged pull requests: 66
  • Bot issues: 0
  • Bot pull requests: 8
Past Year
  • Issues: 10
  • Pull requests: 33
  • Average time to close issues: 2 months
  • Average time to close pull requests: 29 days
  • Issue authors: 5
  • Pull request authors: 6
  • Average comments per issue: 0.6
  • Average comments per pull request: 1.0
  • Merged pull requests: 20
  • Bot issues: 0
  • Bot pull requests: 5
Top Authors
Issue Authors
  • glatard (15)
  • gkiar (9)
  • ramou (8)
  • mathdugre (7)
  • prioux (5)
  • michellewang (5)
  • DarrinFong (4)
  • mandana-mazaheri (4)
  • MontrealSergiy (2)
  • Remi-Gau (2)
  • pvandyken (1)
  • yarikoptic (1)
  • pascalgirard (1)
  • Andesha (1)
  • poquirion (1)
Pull Request Authors
  • mathdugre (27)
  • DarrinFong (26)
  • Remi-Gau (13)
  • glatard (11)
  • dependabot[bot] (8)
  • sandepat (7)
  • gkiar (5)
  • ngeorges-cnrs (5)
  • Aidavhd (4)
  • nx10 (3)
  • yarikoptic (2)
  • codacy-badger (1)
  • tkkuehn (1)
  • prioux (1)
Top Labels
Issue Labels
bug (33) enhancement (29) priority (25) documentation (3) good first issue (3) maintenance (3) import/export (2) tools (2) duplicate (1)
Pull Request Labels
dependencies (8) github_actions (1)

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 6,482 last-month
  • Total docker downloads: 72
  • Total dependent packages: 3
  • Total dependent repositories: 22
  • Total versions: 50
  • Total maintainers: 3
pypi.org: boutiques

Schema for describing bash command-line tools

  • Versions: 50
  • Dependent Packages: 3
  • Dependent Repositories: 22
  • Downloads: 6,482 Last month
  • Docker Downloads: 72
Rankings
Dependent packages count: 2.4%
Dependent repos count: 3.1%
Docker downloads count: 3.4%
Average: 5.0%
Forks count: 6.0%
Downloads: 6.3%
Stargazers count: 9.0%
Maintainers (3)
Last synced: 7 months ago

Dependencies

boutiques/schema/examples/example1/Dockerfile docker
  • centos 7 build
boutiques/tests/bids/example_bad/Dockerfile docker
  • bids/base_fsl latest build
boutiques/tests/bids/example_good/Dockerfile docker
  • bids/base_fsl latest build
.github/workflows/style.yml actions
  • actions/checkout v3 composite
  • actions/setup-node v4 composite
  • actions/setup-python v5 composite
.github/workflows/tests.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v5 composite
  • codecov/codecov-action v5 composite
  • eWaterCycle/setup-apptainer v2 composite
.github/workflows/update_precommit_hooks.yml actions
  • actions/checkout v4 composite
  • actions/setup-python v5 composite
  • peter-evans/create-pull-request v6 composite
pyproject.toml pypi
  • jsonschema *
  • simplejson *
  • tabulate *
  • termcolor *