datapackage

type DataPackage ¶

type DataPackage struct {
	PackagePath    string // Filename of existing or intended data package.
	KeyPath        string // Path to public key file for encrypting or private key file for decrypting
	PublicKeyEmail string // Email of public key for lookup on remote keyserver (alternative to KeyPath)
	KeyPassPath    string // Path to file containing passphrase for the private key
	// contains filtered or unexported fields
}

DataPackage represents a compressed and optionally encrypted file that may or may not exist on disk, yet.

PackagePath is the full path to the data package file, which may or may not exist, yet. If it is empty, the package will be Packed or Unpacked to STDOUT or from STDIN, respectively.

KeyPath is the full path to a file holding an ASCII-armored GPG key for encryption or decryption (in which case the file must contain both public and private keys).

PublicKeyEmail is the email associated with a public key uploaded to a key server and can be used in place of KeyPath for encryption. If both are given, KeyPath is used instead.

KeyPassPath is the full path to a file holding the password for the key. The password can alternatively be exported to the PACKER_KEYPASS environment variable. The environment variable is preferred if both are given.

func (d *DataPackage) Pack(dataDirPath string) error

package main

import (
	"github.com/infomodels/datapackage"
)

func main() {
	d := &datapackage.DataPackage{
		PackagePath:    "/home/user/datapackage.tar.gz.gpg",
		PublicKeyEmail: "testy@test.er",
	}

	d.Pack("/home/user/datadirectory")
}

Output:

func (d *DataPackage) Unpack(dataDirPath string) error

package main

import (
	"github.com/infomodels/datapackage"
)

func main() {
	d := &datapackage.DataPackage{
		PackagePath: "/home/user/datapackage.tar.gz.gpg",
		KeyPath:     "/home/user/keys/public_and_private.asc",
		KeyPassPath: "/home/user/keys/pass.txt",
	}

	d.Unpack("/home/user/datadirectory")
}

Output: