https://github.com/childmindresearch/styx

Compile Python command line tool wrappers from Boutiques descriptors
https://github.com/childmindresearch/styx

Last synced: about 1 month ago
JSON representation

Compile Python command line tool wrappers from Boutiques descriptors

• Host: GitHub
• URL: https://github.com/childmindresearch/styx
• Owner: childmindresearch
• License: mit
• Created: 2023-11-15T18:39:59.000Z (12 months ago)
• Default Branch: main
• Last Pushed: 2024-09-20T18:55:11.000Z (about 2 months ago)
• Last Synced: 2024-09-21T09:52:54.489Z (about 2 months ago)
• Language: Python
• Homepage: https://childmindresearch.github.io/styx/
• Size: 2.82 MB
• Stars: 0
• Watchers: 4
• Forks: 0
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Security: SECURITY.md

Awesome Lists containing this project

README

        
# Styx 

[![Build](https://github.com/childmindresearch/styx/actions/workflows/test.yaml/badge.svg?branch=main)](https://github.com/childmindresearch/styx/actions/workflows/test.yaml?query=branch%3Amain)

[![codecov](https://codecov.io/gh/childmindresearch/styx/branch/main/graph/badge.svg?token=22HWWFWPW5)](https://codecov.io/gh/childmindresearch/styx)

[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)

![stability-wip](https://img.shields.io/badge/stability-work_in_progress-lightgrey.svg)

[![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/childmindresearch/styx/blob/main/LICENSE)

[![pages](https://img.shields.io/badge/api-docs-blue)](https://childmindresearch.github.io/styx)

Command line tool wrapper compiler.

Compile Python command line tool wrappers from JSON metadata.

Supports a superset of the [Boutiques](https://boutiques.github.io/) descriptor format, and generates idiomatic Python

(3.10+) wrappers with type hints, argument parsing, and documentation. Generated code only depends on the Python

standard library (and on shared type definition). Runtimes are decoupled via conde-injection.

## The Styx-verse

### Documentation

- [Styx Book](https://childmindresearch.github.io/styxbook/)

- [Styx Playground](https://childmindresearch.github.io/styxplayground/)

### Precompiled wrappers

- [Neuroimaging](https://github.com/childmindresearch/niwrap)

### Runtimes

- [Docker](https://github.com/childmindresearch/styxdocker)

- [Singularity](https://github.com/childmindresearch/styxsingularity)

### Middleware

- [Graph generation](https://github.com/childmindresearch/styxgraph)

## Installation

Styx is not needed to run the generated wrappers, but is required to compile them.

```bash

pip install git+https://github.com/childmindresearch/styx.git

```

## License

Styx is MIT licensed. The license of the generated wrappers depends on the input metadata.