namaste

README

namaste

This is a Go language port of Namaste (Name as Text) library inspired by the Python implementation of namaste which in turn was ported from Perl implementation.

Go Package

The Go package seeks to mimic the Python implementation as much as possible while expanding on eventual storage options.

Command Line implementation

The command line implementation's purpose is to exercise the Go package and test practical usage and integration into other Caltech Library projects. It is intended to be largely command line compatible with the Python implementation.

Extensions

There are a few things that extend beyond the existing Python namaste implementation which are desirable to test.

• S3 storage support
• Google Cloud Storage support
• Output namaste metadata in JSON format

Documentation

Overview

namaste.go implements the "Name as Text" encoding/decoding for embedding metadata signatures in a directory.

Authors R. S. Doiel, <rsdoiel@library.caltech.edu>

Copyright (c) 2020, Caltech All rights not granted herein are expressly reserved by Caltech.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Index

• Constants
• func Decode(value string) string
• func DirType(dName, val string) (string, error)
• func Encode(tag, value string) string
• func Get(dName string, kinds []string) ([]string, error)
• func GetTypes(dName string) (map[string]map[string]string, error)
• func Note(dName, val string) (string, error)
• func What(dName, val string) (string, error)
• func When(dName, val string) (string, error)
• func Where(dName, val string) (string, error)
• func Who(dName, val string) (string, error)

Constants

const Version = "1.0.1"

Functions

func Decode

func Decode(value string) string

func DirType

func DirType(dName, val string) (string, error)

func Encode

func Encode(tag, value string) string

func Get

func Get(dName string, kinds []string) ([]string, error)

func GetTypes

func GetTypes(dName string) (map[string]map[string]string, error)

func Note

func Note(dName, val string) (string, error)

func What

func What(dName, val string) (string, error)

func When

func When(dName, val string) (string, error)

func Where

func Where(dName, val string) (string, error)

func Who

func Who(dName, val string) (string, error)