Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/calvinmclean/azstocker

Easily get on-demand information about fish stocking in Arizona
https://github.com/calvinmclean/azstocker

Last synced: 14 days ago
JSON representation

Easily get on-demand information about fish stocking in Arizona

Awesome Lists containing this project

README

        

# AZStocker

[![GitHub go.mod Go version (subdirectory of monorepo)](https://img.shields.io/github/go-mod/go-version/calvinmclean/azstocker?filename=go.mod)](https://github.com/calvinmclean/azstocker/blob/main/go.mod)
![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/calvinmclean/azstocker/main.yml?branch=main)
[![License](https://img.shields.io/github/license/calvinmclean/azstocker)](https://github.com/calvinmclean/azstocker/blob/main/LICENSE)
[![Go Reference](https://pkg.go.dev/badge/github.com/calvinmclean/azstocker.svg)](https://pkg.go.dev/github.com/calvinmclean/azstocker)

AZStocker leverages data from [AZ GFD's Stocking Schedule](https://www.azgfd.com/fishing-2/where-to-fish/fish-stocking-schedule/) to provide on-demand information about fish stocking in Arizona.

Check it out at https://azstocker.com!

## How To

Install using `go install` or cloning this repository:

```shell
go install github.com/calvinmclean/azstocker/cmd/azstocker@latest
```

### Get API Key

First, a Google API key is necessary to access the stocking schedule Google Sheet.

Follow [these instructions](https://developers.google.com/sheets/api/quickstart/go) from Google to setup a developer account, then get an API key instead of the Oauth credentials file.

Set the API key as the `API_KEY` environment variable or supply as a CLI flag with `--api-key`

### Run CLI

```shell
# get the last and next Winter stocking dates for the Lower Salt River and Rose Canyon Lake
azstocker get -p winter -w "lower salt river" -w "rose canyon lake" --next --last
```

### Run Server

```shell
# run the server
azstocker server

# use curl to get the last and next stocking dates for all CFP waters
curl 'localhost:8080/cfp?next=true&last=true&showAll=true'
```