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

caltechlibrary · Sep 19, 2024 · 899c4d5 · 899c4d5
2 parents a34a7a2 + 1407928
commit 899c4d5
Show file tree

Hide file tree

Showing 16 changed files with 29 additions and 261 deletions.
diff --git a/INSTALL.md b/INSTALL.md
@@ -49,122 +49,6 @@ $env:PKG_VERSION = '2.1.5'
 irm https://caltechlibrary.github.io/dataset/installer.ps1 | iex
 ~~~
 
-Compiled version
-----------------
-
-Compiled versions are available for macOS (Intel and M1), Linux (Intel),
-Windows (Intel and ARM64) and Raspberry Pi (ARM).
-
-VERSION_NUMBER is a [semantic version number](http://semver.org/) (e.g. v2.0.0)
-
-
-For all the released version go to the project page on GitHub and click
-latest release
-
->    https://github.com/caltechlibrary/dataset/releases/latest
-
-
-| Platform         | Zip Filename                                     |
-|------------------|--------------------------------------------------|
-| Windows (Intel)  | dataset-VERSION_NUMBER-Windows-x86_64.zip        |
-| Windows (ARM 64) | dataset-VERSION_NUMBER-windows-arm64.zip         |
-| macOS (Intel)    | dataset-VERSION_NUMBER-macOS-x86_64.zip          |
-| macOS (M1)       | dataset-VERSION_NUMBER-macOS-arm64.zip           |
-| Linux (Intel)    | dataset-VERSION_NUMBER-Linux-x86_64.zip          |
-| Linux (ARM 64)         | dataset-VERSION_NUMBER-Linux-aarch64.zip   |
-| Raspberry Pi OS (ARM7) | dataset-VERSION_NUMBER-Linux-arm7l.zip     |
-
-
-The basic recipe
-----------------
-
-- Find the Zip file listed matching the architecture you're running and download it
-    - Example Windows machines
-        - If you're on a Windows 10 laptop or desktop with an Intel style CPU you'd choose the Zip file with "Windows-x86_64" in the name
-        - If you're on an ARM based Surface tablet or Windows Developer Kit for ARM then choose "Windows-arm64" in the name
-    - Example macOS machines
-        - If you are on an older Intel based Mac then choose "macOS-x86_64" in the name
-        - If you are on a newer M1, M2 chip based Mac then choose "macOS-arm64" in the name
-- Download the zip file and unzip the file.
-- Copy the contents of the folder named "bin" to a folder that is in your path
-    - (e.g. "bin" in your "HOME" directory is common).
-- Adjust your PATH if needed
-- Test
-
-
-### macOS
-
-1. Download the zip file
-2. Unzip the zip file
-3. Copy the executable to "bin" folder in HOME folder (or another folder in your PATH)
-4. Make sure the new location in in our path
-5. Test
-
-Here's an example of the commands run in the Terminal App after
-downloading the zip file for an Intel based Mac.
-
-```shell
-    cd Downloads/
-    unzip dataset-*-macOS-x86_64.zip
-    mkdir -p $HOME/bin
-    cp -v bin/* $HOME/bin/
-    export PATH=$HOME/bin:$PATH
-    dataset -version
-```
-
-Or on a newer Mac with the M1 or M2 processors.
-
-```shell
-    cd Downloads/
-    unzip dataset-*-macOS-arm64.zip
-    mkdir -p $HOME/bin
-    cp -v bin/* $HOME/bin/
-    export PATH=$HOME/bin:$PATH
-    dataset -version
-```
-
-
-### Windows
-
-1. Download the zip file into your "Downloads" folder
-2. Unzip the zip file
-3. Copy the executable to the "bin" directory in to someplace where Windows cmd shell file find it
-4. Test
-
-Here's an example of the commands run in from the Windows 11 command shell (cmd). I have a folder 
-in my user profile directory `bin` that I keep my command line tools in. When I start up 
-the Windows command shell it knows to look there.  To set that up I do
-
-```shell
-    mkdir %userprofile%\bin
-    set PATH=%PATH%;%userprofile$\bin
-    powershell Expand-Archive Downloads\dataset-*-Windows-*.zip Dataset
-    copy Dataset\bin\*.exe %userprofile%\bin\ 
-    dataset -version
-```
-
-### Linux
-
-NOTE: Windows sub-system for Linux (aka lsw) and Raspberry Pi OS (which is Linux)
-can use this approach.
-
-1. Download the zip file
-2. Unzip the zip file
-3. Copy the executable to the "bin" directory in your "HOME" directory.
-4. Test
-
-Here's an example of the commands run in from the Bash shell after
-downloading the zip file.
-
-```shell
-    cd Downloads/
-    unzip dataset-*-linux-x86_64.zip
-    mkdir -p $HOME/bin
-    cp -v bin/* $HOME/bin/
-    export PATH=$HOME/bin:$PATH
-    dataset -version
-```
-
 ## Compiling from source
 
 You need to have git, Pandoc, Go compiler and Make (GNU Make) available for 
@@ -182,9 +66,20 @@ that is assumed to be in your path.
     make install
 ```
 
+On Windows you would perform the following in Powershell.
+
+```shell
+    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.22 or better
+- Go version 1.23 or better
 - Pandoc version 3.1 or better
 - GNU Make
 - Common POSIX/Unix utilities, e.g. cat, sed, grep
@@ -205,5 +100,5 @@ batch files to perform some of what Make under Linux and macOS would do.
 - release.bat builds a release, will prompt for version
 - clean.bat removes executable and temp files
 
-Compilation assumes [go](https://github.com/golang/go) v1.22 or better.
+Compilation assumes [go](https://github.com/golang/go) v1.23 or better.
 
diff --git a/TODO.html b/TODO.html
@@ -38,6 +38,9 @@ <h2 id="next-prep-for-v2.1.20">Next (prep for v2.1.20)</h2>
 </ul>
 <h2 id="someday-maybe">Someday, Maybe</h2>
 <ul class="task-list">
+<li><label><input type="checkbox" />create a cli named <code>ds</code>
+that wraps all the cli except datasetd similar to how the Go command or
+Git works</label></li>
 <li><label><input type="checkbox" />My current approach to versioning is
 too confusing, causing issues in implementing py_dataset, versioning
 needs to be automatic with a minimum set of methods explicitly

diff --git a/TODO.md b/TODO.md
@@ -15,6 +15,7 @@ Next (prep for v2.1.20)
 Someday, Maybe
 --------------
 
+- [ ] create a cli named `ds` that wraps all the cli except datasetd similar to how the Go command or Git works
 - [ ] My current approach to versioning is too confusing, causing issues in implementing py_dataset, versioning needs to be automatic with a minimum set of methods explicitly supporting it otherwise versioning should just happen in the back ground and only be supported at the package and libdataset levels.
   - [ ] create, read, update, list operations should always reflect the "current" version (objects or attachments), delete should delete all versions of objects as should prune for attachments, this is because versioning suggests things never really get deleted, just replaced.
 - [ ] Common dataset verbs (dataset/datasetd)

diff --git a/about.html b/about.html
@@ -51,7 +51,7 @@ <h3 id="programming-languages">Programming languages</h3>
 </ul>
 <h3 id="software-requiremets">Software Requiremets</h3>
 <ul>
-<li>Golang 1.22 or better</li>
+<li>Golang 1.23 or better</li>
 <li>Pandoc 3.1 or better</li>
 <li>GNU Make</li>
 </ul>

diff --git a/about.md b/about.md
@@ -51,6 +51,6 @@ system or SQL JSON store
 
 ### Software Requiremets
 
-- Golang 1.22 or better
+- Golang 1.23 or better
 - Pandoc 3.1 or better
 - GNU Make
diff --git a/codemeta.json b/codemeta.json
@@ -72,7 +72,7 @@
         "Go"
     ],
     "softwareRequirements": [
-        "Golang 1.22 or better",
+        "Golang 1.23 or better",
         "Pandoc 3.1 or better",
 		"GNU Make"
     ],

diff --git a/install.html b/install.html
@@ -54,143 +54,6 @@ <h2 id="quick-install-with-curl-or-irm">Quick install with curl or
 <p>For Windows</p>
 <pre><code>$env:PKG_VERSION = &#39;2.1.5&#39;
 irm https://caltechlibrary.github.io/dataset/installer.ps1 | iex</code></pre>
-<h2 id="compiled-version">Compiled version</h2>
-<p>Compiled versions are available for macOS (Intel and M1), Linux
-(Intel), Windows (Intel and ARM64) and Raspberry Pi (ARM).</p>
-<p>VERSION_NUMBER is a <a href="http://semver.org/">semantic version
-number</a> (e.g. v2.0.0)</p>
-<p>For all the released version go to the project page on GitHub and
-click latest release</p>
-<blockquote>
-<p>https://github.com/caltechlibrary/dataset/releases/latest</p>
-</blockquote>
-<table>
-<thead>
-<tr class="header">
-<th>Platform</th>
-<th>Zip Filename</th>
-</tr>
-</thead>
-<tbody>
-<tr class="odd">
-<td>Windows (Intel)</td>
-<td>dataset-VERSION_NUMBER-Windows-x86_64.zip</td>
-</tr>
-<tr class="even">
-<td>Windows (ARM 64)</td>
-<td>dataset-VERSION_NUMBER-windows-arm64.zip</td>
-</tr>
-<tr class="odd">
-<td>macOS (Intel)</td>
-<td>dataset-VERSION_NUMBER-macOS-x86_64.zip</td>
-</tr>
-<tr class="even">
-<td>macOS (M1)</td>
-<td>dataset-VERSION_NUMBER-macOS-arm64.zip</td>
-</tr>
-<tr class="odd">
-<td>Linux (Intel)</td>
-<td>dataset-VERSION_NUMBER-Linux-x86_64.zip</td>
-</tr>
-<tr class="even">
-<td>Linux (ARM 64)</td>
-<td>dataset-VERSION_NUMBER-Linux-aarch64.zip</td>
-</tr>
-<tr class="odd">
-<td>Raspberry Pi OS (ARM7)</td>
-<td>dataset-VERSION_NUMBER-Linux-arm7l.zip</td>
-</tr>
-</tbody>
-</table>
-<h2 id="the-basic-recipe">The basic recipe</h2>
-<ul>
-<li>Find the Zip file listed matching the architecture you’re running
-and download it
-<ul>
-<li>Example Windows machines
-<ul>
-<li>If you’re on a Windows 10 laptop or desktop with an Intel style CPU
-you’d choose the Zip file with “Windows-x86_64” in the name</li>
-<li>If you’re on an ARM based Surface tablet or Windows Developer Kit
-for ARM then choose “Windows-arm64” in the name</li>
-</ul></li>
-<li>Example macOS machines
-<ul>
-<li>If you are on an older Intel based Mac then choose “macOS-x86_64” in
-the name</li>
-<li>If you are on a newer M1, M2 chip based Mac then choose
-“macOS-arm64” in the name</li>
-</ul></li>
-</ul></li>
-<li>Download the zip file and unzip the file.</li>
-<li>Copy the contents of the folder named “bin” to a folder that is in
-your path
-<ul>
-<li>(e.g. “bin” in your “HOME” directory is common).</li>
-</ul></li>
-<li>Adjust your PATH if needed</li>
-<li>Test</li>
-</ul>
-<h3 id="macos">macOS</h3>
-<ol type="1">
-<li>Download the zip file</li>
-<li>Unzip the zip file</li>
-<li>Copy the executable to “bin” folder in HOME folder (or another
-folder in your PATH)</li>
-<li>Make sure the new location in in our path</li>
-<li>Test</li>
-</ol>
-<p>Here’s an example of the commands run in the Terminal App after
-downloading the zip file for an Intel based Mac.</p>
-<pre class="shell"><code>    cd Downloads/
-    unzip dataset-*-macOS-x86_64.zip
-    mkdir -p $HOME/bin
-    cp -v bin/* $HOME/bin/
-    export PATH=$HOME/bin:$PATH
-    dataset -version</code></pre>
-<p>Or on a newer Mac with the M1 or M2 processors.</p>
-<pre class="shell"><code>    cd Downloads/
-    unzip dataset-*-macOS-arm64.zip
-    mkdir -p $HOME/bin
-    cp -v bin/* $HOME/bin/
-    export PATH=$HOME/bin:$PATH
-    dataset -version</code></pre>
-<h3 id="windows">Windows</h3>
-<ol type="1">
-<li>Download the zip file into your “Downloads” folder</li>
-<li>Unzip the zip file</li>
-<li>Copy the executable to the “bin” directory in to someplace where
-Windows cmd shell file find it</li>
-<li>Test</li>
-</ol>
-<p>Here’s an example of the commands run in from the Windows 11 command
-shell (cmd). I have a folder in my user profile directory
-<code>bin</code> that I keep my command line tools in. When I start up
-the Windows command shell it knows to look there. To set that up I
-do</p>
-<pre class="shell"><code>    mkdir %userprofile%\bin
-    set PATH=%PATH%;%userprofile$\bin
-    powershell Expand-Archive Downloads\dataset-*-Windows-*.zip Dataset
-    copy Dataset\bin\*.exe %userprofile%\bin\ 
-    dataset -version</code></pre>
-<h3 id="linux">Linux</h3>
-<p>NOTE: Windows sub-system for Linux (aka lsw) and Raspberry Pi OS
-(which is Linux) can use this approach.</p>
-<ol type="1">
-<li>Download the zip file</li>
-<li>Unzip the zip file</li>
-<li>Copy the executable to the “bin” directory in your “HOME”
-directory.</li>
-<li>Test</li>
-</ol>
-<p>Here’s an example of the commands run in from the Bash shell after
-downloading the zip file.</p>
-<pre class="shell"><code>    cd Downloads/
-    unzip dataset-*-linux-x86_64.zip
-    mkdir -p $HOME/bin
-    cp -v bin/* $HOME/bin/
-    export PATH=$HOME/bin:$PATH
-    dataset -version</code></pre>
 <h2 id="compiling-from-source">Compiling from source</h2>
 <p>You need to have git, Pandoc, Go compiler and Make (GNU Make)
 available for this recipe to work. Clone the repository and then compile
@@ -203,9 +66,15 @@ <h2 id="compiling-from-source">Compiling from source</h2>
     # Add any missing dependencies you might need in your Go environment
     make test
     make install</code></pre>
+<p>On Windows you would perform the following in Powershell.</p>
+<pre class="shell"><code>    cd
+    git clone https://github.com/caltechlibrary/dataset
+    cd dataset
+    .\make.bat
+    # Follow the prompts and instruction in the bat file.</code></pre>
 <h3 id="requirements">Requirements</h3>
 <ul>
-<li>Go version 1.22 or better</li>
+<li>Go version 1.23 or better</li>
 <li>Pandoc version 3.1 or better</li>
 <li>GNU Make</li>
 <li>Common POSIX/Unix utilities, e.g. cat, sed, grep</li>
@@ -228,7 +97,7 @@ <h3 id="windows-compilation">Windows compilation</h3>
 <li>clean.bat removes executable and temp files</li>
 </ul>
 <p>Compilation assumes <a href="https://github.com/golang/go">go</a>
-v1.22 or better.</p>
+v1.23 or better.</p>
 </section>
 
 <footer>

diff --git a/pagefind/fragment/unknown_ac7ce71.pf_fragment b/pagefind/fragment/unknown_ac7ce71.pf_fragment
diff --git a/pagefind/fragment/unknown_f9fd1d8.pf_fragment b/pagefind/fragment/unknown_f9fd1d8.pf_fragment
diff --git a/pagefind/index/unknown_51a6532.pf_index b/pagefind/index/unknown_51a6532.pf_index
diff --git a/pagefind/index/unknown_51af9f8.pf_index b/pagefind/index/unknown_51af9f8.pf_index
diff --git a/pagefind/index/unknown_dff2d47.pf_index b/pagefind/index/unknown_dff2d47.pf_index
diff --git a/pagefind/index/unknown_ffba5d0.pf_index b/pagefind/index/unknown_ffba5d0.pf_index
diff --git a/pagefind/pagefind-entry.json b/pagefind/pagefind-entry.json
@@ -1 +1 @@
-{"version":"1.1.1","languages":{"unknown":{"hash":"unknown_51d1e7faa9edda8","wasm":null,"page_count":79}}}
+{"version":"1.1.1","languages":{"unknown":{"hash":"unknown_6f44d5b13a307ef","wasm":null,"page_count":79}}}
diff --git a/pagefind/pagefind.unknown_43e4383510cefcd.pf_meta b/pagefind/pagefind.unknown_43e4383510cefcd.pf_meta
diff --git a/pagefind/pagefind.unknown_6f44d5b13a307ef.pf_meta b/pagefind/pagefind.unknown_6f44d5b13a307ef.pf_meta
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		{"version":"1.1.1","languages":{"unknown":{"hash":"unknown_51d1e7faa9edda8","wasm":null,"page_count":79}}}
		{"version":"1.1.1","languages":{"unknown":{"hash":"unknown_6f44d5b13a307ef","wasm":null,"page_count":79}}}