hubzone

README

HUBZone Checker

Overview

This is a command line program to check the HUBZone statuses of a list of addresses.

Usage:

$ hubzone [inputCSV] [addressesColumnName] [extraColumnName...]

The input .csv must contain at least one named column which contains the addresses. Addresses can be in any human readable format, but sticking to standards will help ensure error-free lookups.

The output will be another .csv file named output.csv. The first column of the file is named "HUBZone", and will contain the HUBZone statuses of the corresponding addresses. That is, "Yes" for addresses which lie in qualified HUBZones, and "No" for addresses which do not lie in qualified HUBZones. In addition, the output will contain a copy of the addresses column from the input .csv, as well as copies of any other columns which were provided and also found in the input .csv. The relative order of the address column and any additional columns is preserved from the input .csv.

The HUBZone status information is gathered in real time via the public API at https://maps.certify.sba.gov/

Documentation for the API can be found here: https://github.com/USSBA/hubzone-api

Installation

If on GNU/Linux x86_64, simply download the latest release binary (found under the releases tab as "hubzone") and place it in your $PATH. Alternatively download the latest dev binary at bin/hubzone.

If you have go installed, you can use

go install codeberg.org/mrh/hubzone@latest

It will most likely be installed at $GOPATH/bin/hubzone. Check go env and go help install for more details.

To build from source, you will need git and go >= 1.18. Clone this repository via git clone https://codeberg.org/mrh/hubzone, then cd into the cloned repo directory via cd hubzone and run go -o hubzone build. Then place the resulting binary hubzone in your $PATH.