hubzone

command module
v0.0.0-...-0997b84 Latest Latest
Warning

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

Go to latest
Published: Jan 21, 2024 License: AGPL-3.0 Imports: 11 Imported by: 0

README

#+OPTIONS: toc:nil

* HUBZone Checker
** Overview
This is a command line program to bulk check the [[https://www.sba.gov/federal-contracting/contracting-assistance-programs/hubzone-program][HUBZone]] statuses of many addresses, as well generate pdf maps verifying the qualified statuses.
*** Usage
=hubzone [inputCSV] [addressColumn] [extraColumn...]=
*** Description
The input CSV must contain at least one named column for the addresses. Addresses can be in any human readable format, but sticking to standards will help ensure error-free lookups

The first output will be another CSV file named /output.csv/.

- The first column of the output CSV is titled "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 CSV will contain a copy of the address column from the input CSV, as well as copies of any other columns which were provided
- The relative order of the address column and any additional columns provided is preserved from the input CSV

The second output will be pdf files placed in the local directory =qualified-maps=. If =qualified-maps= does not exist at the time of running, it will be created.
There will be exactly one pdf file per hubzone qualified address. Each pdf will contain a map showing the pinned location of the address in the center, and the hubzone region coverage in that area, proving that that address does indeed lie within a hubzone.
*** Sources
The HUBZone status information is gathered in real time via the public API here: [[https://maps.certify.sba.gov][maps.certify.sba.gov]].

Documentation for the API can be found here: [[https://github.com/USSBA/hubzone-api][github.com/USSBA/hubzone-api]].
** Installation
To obtain the program you can grab the development binary at =bin/hubzone=.

To build from source, install Go >=1.21 and run =go install codeberg.org/mrh/hubzone=.

Documentation

The Go Gopher

There is no documentation for this package.

Jump to

Keyboard shortcuts

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