harvester

command module
v0.2.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 14, 2026 License: MIT Imports: 1 Imported by: 0

README

Harvester

DOI

Harvester converts biodiversity datasets from various formats into SFGA (Species File Group Archive) — a standardized format for taxonomic data.

Introduction

Quite often, important biodiversity datasets do not have a standard archive package and cannot be easily converted to one by using the SF project. Their data may be distributed as custom CSV/TSV dumps, proprietary databases, or complex archives with no common structure.

Harvester bridges this gap. It downloads datasets from their original sources, extracts and parses the data, and transforms it into SFGA — a uniform SQLite-based format covering taxonomic names, synonyms, vernacular names, references, and distributions. Currently supported sources include GRIN, ITIS, NCBI, ION, IOC Birds, PaleoDB, Wikispecies, and World Plants. SFGA files can by easily converted to other popular biodiversity formats using SF application.

Installation

Binary release

Download the latest binary for your platform from the releases page.

From source

Requires Go 1.25+.

go install github.com/sfborg/harvester@latest

Usage

List available data sources
harvester list        # show all supported datasets
harvester list -v     # show details for each dataset
Convert a dataset
harvester get <label> <output-file> # download and convert to SFGA
harvester get <label> -s <output>   # skip download, use cached data
harvester get <label> -z <output>   # output as compressed zip file

Replace <label> with a dataset identifier or its row number from harvester list. For the output, provide only the file name. Several files will be generated.

Example
harvester list
harvester list -v
harvester get itis ~/tmp/itis
harvester get 3 ~/tmp/itis
harvester get ncbi -z ~/tmp/ncbi

If no output target is given, converted files are saved as SFGA archives in the current directory.

Output format

Harvester produces SFGA archives — SQLite databases following a common schema for taxonomic names, synonyms, vernacular names, references, and distributions.

Extension Description
.sql SQL dump (plain text)
.sqlite SQLite binary database
.sql.zip SQL dump, compressed
.sqlite.zip SQLite binary database, compressed

Note that when providing output path only the file name is needed, extensions will be added automatically.

Development

See AGENTS.md for build instructions, architecture overview, and how to add new data sources.

Authors

License

Released under MIT license

Artificial Intelligence Policy

We use artificial intelligence to help find algorithms, decide on implementation approaches, and generate code. All automatically generated code is carefully reviewed, with inconsistencies fixed, superfluous implementations removed, and optimizations improved. No code that we do not understand or approve makes it into published versions of Harvester. We primarily use Claude Code, with limited use of Gemini CLI.

Documentation

Overview

Copyright © 2025 Dmitry Mozzherin <dmozzherin@gmail.com>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL