tohaya/README.md

Convert citation file formats to hayagriva YAML

# tohaya

Convert citation files to [hayagriva](https://github.com/typst/hayagriva) YAML.

Supported file formats:

- [Pubmed](https://pubmed.ncbi.nlm.nih.gov/help/#pubmed-format) (`*.nbib`)
- BibLaTeX
- Support coming soon: RIS, EndNote XML, CSV

## Usage

`tohaya` can be used as a web application at https://fnndsc.github.io/tohaya,
or as a command-line program.

### Examples

```shell
# Convert file and create output file
tohaya citation.nbib --output bibliography.yml

# Alternatively, using pipes
cat citation.nbib | tohaya - >> bibliography.yml
```

## Installation

- **Direct download** from https://github.com/FNNDSC/tohaya/releases/latest
- **[Nix](https://nixos.org/) flakes**: figure it out yourself
- **Compile from source**: `cargo install tohaya`
- [**cargo-binstall**](https://github.com/cargo-bins/cargo-binstall): `cargo binstall tohaya`

## Development

The CLI can be developed as usual:

```shell
cargo test
```

The web app is a plain static HTML file found in [`web/`](./web).
It requires `tohaya` to be built using
[wasm-pack](https://rustwasm.github.io/wasm-pack/installer/).

A convenient development environment is provided using [nix](https://nix.dev/manual/nix/2.28/command-ref/new-cli/nix3-develop.html):

```shell
nix develop -c just
```

## Acknowledgements

- The upstream [typst/hayagriva](https://github.com/typst/hayagriva) project provides
  the BibTeX -> hayagriva conversion library. It also has a CLI of its own.
- All input formats besides BibTeX are supported thanks to [biblib](https://crates.io/crates/biblib)
- Web app design is inspired by [JonasLoos/bibtext-to-hayagriva-webapp](https://github.com/JonasLoos/bibtex-to-hayagriva-webapp)

## Roadmap

- [ ] Installation from PyPi using [maturin](https://github.com/PyO3/maturin)
- [ ] Installation using [pixi](https://pixi.sh/)/[mamba](https://mamba.readthedocs.io)/[conda](https://conda.io)
- [ ] Possible upstream integration with hayagriva, see https://github.com/typst/hayagriva/issues/329