Merge branch 'main' of github.com:caltechlibrary/datatools into gh-pages

Author: R. S. Doiel

.github/workflows/codemeta2cff.yaml

@@ -0,0 +1,28 @@
+name: CodeMeta2CFF
+run-name: Run CodeMeta2CFF after ${{github.event_name}} by ${{github.actor}}
+
+on:
+  push:
+    paths: ['codemeta.json']
+  workflow_dispatch:
+    inputs:
+      reason:
+        description: 'Reason'
+        required: false
+        default: 'Manual trigger'
+
+jobs:
+  CodeMeta2CFF:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Convert CFF
+        uses: caltechlibrary/codemeta2cff@main
+      - name: Commit CFF
+        uses: EndBug/add-and-commit@v9
+        with:
+          message: 'Add updated CITATION.cff from codemeta.json file'
+          add: 'CITATION.cff'

CITATION.cff

@@ -3,7 +3,9 @@ message: "If you use this software, please cite it as below."
 type: software
 title: "datatools"
 abstract: "A set of command line tools for working with CSV, Excel
-Workbooks, JSON and structured text documents."
+Workbooks, JSON and structured text documents. Included are tools for
+handling urlencoding and urldecoding as well as path relationships on
+the file system and in URLs"
 authors:
   - family-names: Doiel
     given-names: R. S.
@@ -15,7 +17,7 @@ maintainers:
     orcid: ""
 
 repository-code: "https://github.com/caltechlibrary/datatools"
-version: 1.3.4
+version: 1.3.5
 license-url: "https://data.caltech.edu/license"
-keywords: [ "csv", "excel", "sql", "json", "yaml", "xlsx", "golang", "bash" ]
-date-released: 2025-05-15
+keywords: [ "csv", "excel", "sql", "json", "yaml", "xlsx", "golang", "bash", "url", "urlencoding" ]
+date-released: 2026-02-12

Makefile

@@ -9,9 +9,9 @@ RELEASE_DATE=$(shell date +'%Y-%m-%d')
 
 RELEASE_HASH=$(shell git log --pretty=format:'%h' -n 1)
 
-PROGRAMS = codemeta2cff csv2json  csv2jsonl csv2mdtable csv2tab csv2xlsx csvcleaner csvcols csvfind csvjoin csvrows finddir findfile json2toml json2yaml jsoncols jsonjoin jsonmunge jsonrange jsonobjects2csv json2jsonl mergepath range reldate reltime sql2csv string tab2csv timefmt toml2json urlparse xlsx2csv xlsx2json yaml2json
+PROGRAMS = codemeta2cff csv2json  csv2jsonl csv2mdtable csv2tab csv2xlsx csvcleaner csvcols csvfind csvjoin csvrows finddir findfile json2toml json2yaml jsoncols jsonjoin jsonmunge jsonrange jsonobjects2csv json2jsonl mergepath range reldate reltime sql2csv string tab2csv timefmt toml2json urlparse xlsx2csv xlsx2json yaml2json urldecode urlencode reldocpath
 
-MAN_PAGES = codemeta2cff.1 csv2json.1 csv2jsonl.1 csv2mdtable.1 csv2tab.1 csv2xlsx.1 csvcleaner.1 csvcols.1 csvfind.1 csvjoin.1 csvrows.1 finddir.1 findfile.1 json2toml.1 json2yaml.1 jsoncols.1 jsonjoin.1 jsonmunge.1 jsonrange.1  jsonobjects2csv.1 json2jsonl.1 mergepath.1 range.1 reldate.1 reltime.1 sql2csv.1 string.1 tab2csv.1 timefmt.1 toml2json.1 urlparse.1 xlsx2csv.1 xlsx2json.1 yaml2json.1
+MAN_PAGES = codemeta2cff.1 csv2json.1 csv2jsonl.1 csv2mdtable.1 csv2tab.1 csv2xlsx.1 csvcleaner.1 csvcols.1 csvfind.1 csvjoin.1 csvrows.1 finddir.1 findfile.1 json2toml.1 json2yaml.1 jsoncols.1 jsonjoin.1 jsonmunge.1 jsonrange.1  jsonobjects2csv.1 json2jsonl.1 mergepath.1 range.1 reldate.1 reltime.1 sql2csv.1 string.1 tab2csv.1 timefmt.1 toml2json.1 urlparse.1 xlsx2csv.1 xlsx2json.1 yaml2json.1 urldecode.1 urlencode.1 reldocpath.1
 
 PACKAGE = $(shell ls -1 *.go)
 
@@ -215,6 +215,7 @@ gen_batfiles: .FORCE
 snap: dist/datatools_$(VERSION)_amd64.snap
 
 release: .FORCE clean build man gen_batfiles distribute_docs dist/Linux-armv7l dist/Linux-aarch64 dist/Linux-x86_64 dist/macOS-x86_64 dist/macOS-arm64 dist/Windows-x86_64 dist/Windows-arm64
+	git pull origin $(BRANCH)
 	echo "ready to run ./release.bash"
 
 

README.md

@@ -2,26 +2,26 @@
 datatools
 =========
 
-_datatools_ is a rich collection of command line programs targetting
+_datatools_ is a rich collection of command line programs targeting
 data conversion, cleanup and analysis directly from your favorite
-POSIX shell. It has proven useful for data collaberations where
-individual members of a project may prefer different toolsets in their
+POSIX shell or Powershell. It has proven useful for data collaborations where
+individual members of a project may prefer different tool sets in their
 analysis (e.g. Julia, R, Python) but want to work from a common baseline.
 It also has been used intensively for internal reporting from various
 Caltech Library metadata sources.
 
-The tools fall into three broad categories 
+The tools fall into three broad categories
 
 - data transformation and conversion
 - shell scripting helpers
 - "string", a tool providing the common string operations missing from shell
 
 See [user manual](user-manual.md) for a complete list of the command line
 programs. The data transformation tools include support for formats such as
-Excel XML, csv, tab delimited files, json, yaml and toml.
+Excel XML, csv, tab delimited files, json, yaml, toml and url encoding/decoding.
 
-Compiled versions of the datatools collection are provided for Linux
-(amd64), Mac OS X (amd64), Windows 10 (amd64) and Raspbian (ARM7).
+Compiled versions of the datatools collection are provided for Linux (aarch64/amd64),
+Mac OS X (aarch64/amd64), Windows 10 (aarch64/amd64) and Raspberry Pi OS (aarch64).
 See https://github.com/caltechlibrary/datatools/releases.
 
 Use "-help" option for a full list of options for each utility (e.g. `csv2json -help`).
@@ -30,38 +30,37 @@ Data transformation
 -------------------
 
 The tooling around transformation includes data conversion. These
-include tools that work with CSV, tab delimited, JSON, TOML, YAML
-and Excel XML.
+include tools that work with CSV, tab delimited, JSON, TOML, YAML,
+Excel XML, and url encoded text.
 
 There is also tooling to change data shapes using JSON as the
 intermediate data format.
 
 For the shell
 -------------
 
-Various utilities for simplifying work on the command line. 
+Various utilities for simplifying work on the command line.
 
-+ [findfile](docs/findfile/) - find files based on prefix, suffix or contained string
-+ [finddir](docs/finddir/) - find directories based on prefix, suffix or contained string
-+ [mergepath](docs/mergepath/) - prefix, append, clip path variables
-+ [range](docs/range/) - emit a range of integers (useful for numbered loops in Bash)
-+ [reldate](docs/reldate/) - display a relative date in YYYY-MM-DD format
-+ [reltime](docs/reltime/) - display a relative time in 24 hour notation, HH:MM:SS format
-+ [timefmt](docs/timefmt/) - format a time value based on Golang's time format language
-+ [urlparse](docs/urlparse/) - split a URL into parts
+- [mergepath](docs/mergepath/) - prefix, append, clip path variables
+- [reldocpath](reldocpath.1.md) - calculates relative paths given do paths
+- [range](docs/range/) - emit a range of integers (useful for numbered loops in Bash)
+- [reldate](docs/reldate/) - display a relative date in YYYY-MM-DD format
+- [reltime](docs/reltime/) - display a relative time in 24 hour notation, HH:MM:SS format
+- [timefmt](docs/timefmt/) - format a time value based on Golang's time format language
+- [urlparse](docs/urlparse/) - split a URL into parts
 
 For strings
 -----------
 
-_datatools_ provides the [string](docs/string/) command for working with 
-text strings (limited to memory available).  This is commonly needed when 
-cleanup data for analysis. The _string_ command was created for when the 
-old Unix standbys- grep, awk, sed, tr are unwieldly or inconvient. 
-_string_ provides operations are common in most language like, trimming, 
-spliting, and transforming letter case.  The _string_ command also makes 
-it easy to join JSON string arrays into single a string using a delimiter 
-or split a string into a JSON array based on a delimiter. The form of the 
-command is `string [OPTIONS] [ACTION] [ARCTION_PARAMETERS...]`
+_datatools_ provides the [string](docs/string/) command for working with
+text strings (limited to memory available).  This is commonly needed when
+cleanup data for analysis. The _string_ command was created for when the
+old Unix standbys- grep, awk, sed, tr are unwieldy or inconvenient.
+_string_ provides operations are common in most language like, trimming,
+splitting, and transforming letter case.  The _string_ command also makes
+it easy to join JSON string arrays into single a string using a delimiter
+or split a string into a JSON array based on a delimiter. The form of the
+command is `string [OPTIONS] [ACTION] [ACTION_PARAMETERS...]`
 
 ```shell
     string toupper "one two three"
@@ -82,6 +81,5 @@ See [string](docs/string/) for full details
 Installation
 ------------
 
-See [INSTALL.md](install.html) for details for installing pre-compiled 
+See [INSTALL.md](https://caltechlibrary.github.io/datatools/INSTALL.html) for details for installing pre-compiled
 versions of the programs.
-

about.html

@@ -25,7 +25,7 @@
 </nav>
 <section>
 <h1 id="about-this-software">About this software</h1>
-<h2 id="datatools-1.3.4">datatools 1.3.4</h2>
+<h2 id="datatools-1.3.5">datatools 1.3.5</h2>
 <h3 id="authors">Authors</h3>
 <ul>
 <li>R. S. Doiel</li>
@@ -35,7 +35,9 @@ <h3 id="maintainers">Maintainers</h3>
 <li>R. S. Doiel</li>
 </ul>
 <p>A set of command line tools for working with CSV, Excel Workbooks,
-JSON and structured text documents.</p>
+JSON and structured text documents. Included are tools for handling
+urlencoding and urldecoding as well as path relationships on the file
+system and in URLs</p>
 <ul>
 <li>License: <a href="https://data.caltech.edu/license"
 class="uri">https://data.caltech.edu/license</a></li>
@@ -46,7 +48,7 @@ <h3 id="maintainers">Maintainers</h3>
 </ul>
 <h3 id="programming-languages">Programming languages</h3>
 <ul>
-<li>Go &gt;= 1.23.5</li>
+<li>Go &gt;= 1.25.6</li>
 </ul>
 <h3 id="operating-systems">Operating Systems</h3>
 <ul>
@@ -56,7 +58,7 @@ <h3 id="operating-systems">Operating Systems</h3>
 </ul>
 <h3 id="software-requiremets">Software Requiremets</h3>
 <ul>
-<li>Golang &gt;= 1.23.5</li>
+<li>Golang &gt;= 1.25.6</li>
 <li>Pandoc &gt;= 3.1</li>
 </ul>
 </section>

about.md

@@ -4,23 +4,25 @@ message: "If you use this software, please cite it as below."
 type: software
 title: "datatools"
 abstract: "A set of command line tools for working with CSV, Excel
-Workbooks, JSON and structured text documents."
+Workbooks, JSON and structured text documents. Included are tools for
+handling urlencoding and urldecoding as well as path relationships on
+the file system and in URLs"
 authors:
   - family-names: Doiel
     given-names: R. S.
     orcid: ""
 
 repository-code: "https://github.com/caltechlibrary/datatools"
-version: 1.3.4
+version: 1.3.5
 license-url: "https://data.caltech.edu/license"
-keywords: [ "csv", "excel", "sql", "json", "yaml", "xlsx", "golang", "bash" ]
-date-released: 2025-05-15
+keywords: [ "csv", "excel", "sql", "json", "yaml", "xlsx", "golang", "bash", "url", "urlencoding" ]
+date-released: 2026-02-12
 ---
 
 About this software
 ===================
 
-## datatools 1.3.4
+## datatools 1.3.5
 
 ### Authors
 
@@ -32,7 +34,9 @@ About this software
 - R. S. Doiel
 
 A set of command line tools for working with CSV, Excel Workbooks, JSON
-and structured text documents.
+and structured text documents. Included are tools for handling
+urlencoding and urldecoding as well as path relationships on the file
+system and in URLs
 
 - License: <https://data.caltech.edu/license>
 - GitHub: <https://github.com/caltechlibrary/datatools>
@@ -41,7 +45,7 @@ and structured text documents.
 
 ### Programming languages
 
-- Go &gt;= 1.23.5
+- Go &gt;= 1.25.6
 
 ### Operating Systems
 
@@ -51,5 +55,5 @@ and structured text documents.
 
 ### Software Requiremets
 
-- Golang &gt;= 1.23.5
+- Golang &gt;= 1.25.6
 - Pandoc &gt;= 3.1

cmd/reldocpath/reldocpath.go

@@ -0,0 +1,109 @@
+//
+// reldocpath.go takes a source document path and a target document path with same base path
+// returning a relative path to the target file.
+//
+// @author R. S. Doiel, <rsdoiel@caltech.edu>
+//
+// Copyright (c) 2021, 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.
+//
+package main
+
+import (
+	"flag"
+	"fmt"
+	"os"
+	"path"
+
+	// My packages
+	"github.com/caltechlibrary/datatools"
+)
+
+var (
+	helpText = `%{app_name}(1) user manual | version {version} {release_hash}
+% R. S. Doiel
+% {release_date}
+
+# NAME
+
+{app_name}
+
+# SYNOPSIS
+
+{app_name} [OPTIONS] [STRING]
+
+# DESCRIPTION
+
+Given a source document path, a target document path calculate and
+the implied common base path calculate the relative path for target.
+
+# EXAMPLE
+
+Given
+
+    reldocpath chapter-01/lesson-03.html css/site.css
+
+would output
+
+    ../css/site.css
+
+`
+
+	// Standard options
+	showHelp         bool
+	showVersion      bool
+	showLicense      bool
+	showExamples     bool
+)
+
+func main() {
+	appName := path.Base(os.Args[0])
+	version := datatools.Version
+	license := datatools.LicenseText
+	releaseDate := datatools.ReleaseDate
+	releaseHash := datatools.ReleaseHash
+
+	// Standard Options
+	flag.BoolVar(&showHelp, "help", showHelp, "display help")
+	flag.BoolVar(&showLicense, "license", showLicense, "display license")
+	flag.BoolVar(&showVersion, "version", showVersion, "display version")
+
+	// Parse environment and options
+	flag.Parse()
+	args := flag.Args()
+
+	//in := os.Stdin
+	out := os.Stdout
+	eout := os.Stderr
+
+	// Handle the default options
+	if showHelp {
+			fmt.Fprintf(out, "%s\n", datatools.FmtHelp(helpText, appName, version, releaseDate, releaseHash))
+			os.Exit(0)
+	}
+	if showLicense == true {
+			fmt.Fprintf(out, "%s\n", license)
+			os.Exit(0)
+	}
+	if showVersion == true {
+			fmt.Fprintf(out, "datatools, %s %s %s\n", appName, version, releaseHash)
+			os.Exit(0)
+	}
+
+	if len(args) != 2 {
+		fmt.Fprintf(eout, "Expected a source and target file path\n For help try: %s -help", appName)
+		os.Exit(1)
+	}
+	source, target := args[0], args[1]
+	fmt.Fprintf(out, `%s`, datatools.RelativeDocPath(source, target))
+}