Skip to content

Latest commit

 

History

History
104 lines (76 loc) · 2.9 KB

INSTALL.md

File metadata and controls

104 lines (76 loc) · 2.9 KB

Installation

dataset is a set of command line programs run from a shell like Bash. It is designed for single user, single process management of a JSON object documents as a collection where JSON documents are referenced by a unique identifier or key. datasetd is a web service which serves a similar purpose but is intended for supporting multi-user and multi-processes.

This is generalized instructions for a release. For deployment suggestions see NOTES.md

Quick install with curl or irm

There is an experimental installer.sh script that can be run with the following command to install latest table release. This may work for macOS, Linux and if you're using Windows with the Unix subsystem. This would be run from your shell (e.g. Terminal on macOS).

curl https://caltechlibrary.github.io/dataset/installer.sh | sh

This will install dataset and datasetd in your $HOME/bin directory.

If you are running Windows 10 or 11 use the Powershell command below.

irm https://caltechlibrary.github.io/dataset/installer.ps1 | iex

If your want to install a specific verions set the PKG_VERSION environment variable then download. E.g. version 2.1.5 in tihs example.

For Linux and macOS

export PKG_VERSION=2.1.5
curl https://caltechlibrary.github.io/dataset/installer.sh | sh

For Windows

$env:PKG_VERSION = '2.1.5'
irm https://caltechlibrary.github.io/dataset/installer.ps1 | iex

Compiling from source

You need to have git, Pandoc, Go compiler and Make (GNU Make) available for this recipe to work. Clone the repository and then compile in the typical POSIX style. NOTE by default the binaries are installed in $HOME/bin and that is assumed to be in your path.

    cd
    git clone https://github.com/caltechlibrary/dataset
    cd dataset
    make
    # Add any missing dependencies you might need in your Go environment
    make test
    make install

On Windows you would perform the following in Powershell.

    cd
    git clone https://github.com/caltechlibrary/dataset
    cd dataset
    .\make.bat
    # Follow the prompts and instruction in the bat file.

Requirements

  • Go version 1.23 or better
  • Pandoc version 3.1 or better
  • GNU Make
  • Common POSIX/Unix utilities, e.g. cat, sed, grep

Windows compilation

The tool chain to compile on Windows make several assumptions.

  1. You're using Anaconda shell and have the C tool chain installed for cgo to work
  2. GNU Make, cat, grep and sed
  3. You have the latest Go installed

Since I don't assume a POSIX shell environment on windows I have made batch files to perform some of what Make under Linux and macOS would do.

  • make.bat builds our application and depends on go and jq commands
  • release.bat builds a release, will prompt for version
  • clean.bat removes executable and temp files

Compilation assumes go v1.23 or better.