README.md

nf-schema-builder

A minimal CLI tool built with Typer.

Installation

Using Conda (Recommended)

1. Create and activate the conda environment:

conda env create -f environment.yml
conda activate nf-schema-builder

2. Install pre-commit hooks:

pre-commit install

Alternative Installation (pip)

If you prefer using pip directly:

pip install -e ".[dev]"
pre-commit install

Usage

nf-schema-builder send tests/test-schema-full.json

Development

This project uses Ruff for linting and formatting.

Development Tools

This project uses:

• Ruff for linting and formatting
• pyright for static type checking
• pre-commit for automated checks

Setup

1. Install development dependencies:

pip install -e ".[dev]"

2. Install pre-commit hooks:

pre-commit install

Development Workflow

The pre-commit hooks will automatically run on every commit. You can also run them manually:

pre-commit run --all-files

To check types:

pyright nf_schema_builder