A package manager for Workflow Description Language files.
Request Feature
·
Report Bug
·
⭐ Consider starring the repo! ⭐
sprocket check
Checks the syntactic validity of Workflow Description Language files.sprocket lint
Lint Workflow Description Language files.sprocket explain
Explain lint rules.
- Modern, reliable foundation for everyday bioinformatics analysis—written in Rust.
sprocket
aims to package together a fairly comprehensive set of tools and for developing bioinformatics tasks and workflows using the Workflow Description Language. It is built with modern, multi-core systems in mind and written in Rust. - WDL specification focused. We aim to implement the various versions of the OpenWDL specification to the letter. In other words,
sprocket
aims to be workflow engine independent. In the future, we plan to makesprocket
extendable for workflow engine teams.
Before you can install sprocket
, you'll need to install
Rust. We recommend using
rustup to accomplish this.
Once Rust is installed, you can install the latest version of sprocket
by
running the following command.
cargo install sprocket
To bootstrap a development environment, please use the following commands.
# Clone the repository
git clone git@github.com:stjude-rust-labs/sprocket.git
cd sprocket
# Build the crate in release mode
cargo build --release
# Run the `sprocket` command line tool
cargo run --release
Before submitting any pull requests, please make sure the code passes the following checks (from the root directory).
# Run the project's tests.
cargo test --all-features
# Run the tests for the examples.
cargo test --examples --all-features
# Ensure the project doesn't have any linting warnings.
cargo clippy --all-features
# Ensure the project passes `cargo fmt`.
cargo fmt --check
# Ensure the docs build.
cargo doc
Contributions, issues and feature requests are welcome! Feel free to check issues page.
This project is licensed as either Apache 2.0 or MIT at your discretion.
Copyright © 2023-Present St. Jude Children's Research Hospital.