Skip to content

Commit 320ae5a

Browse files
rsdoielrsdoiel
committed
updated docs regarding reliance on old version of xlsx library
1 parent 532f623 commit 320ae5a

File tree

4 files changed

+66
-40
lines changed

4 files changed

+66
-40
lines changed

‎INSTALL.md‎

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -122,14 +122,27 @@ downloading the zip file.
122122

123123
## Compiling from source
124124

125-
_datatools_ is "go gettable". Use the "go get" command to download the dependant packages
125+
_datatools_ is "go gettable" if you have gotten xlsx v1.0.5 package from [github.com/tealeg/xlsx](https://github.com/tealeg/xlsx). The datatools package does not support versions v2.x and greater of xlsx. Below are the steps
126+
I use today with "go get" command to download the dependant packages
126127
as well as _datatools_'s source code.
127128

129+
Setting up the right version of xlsx for datatools
130+
128131
```shell
129-
go get -u github.com/caltechlibrary/datatools/...
132+
cd
133+
go get github.com/tealeg/xlsx
134+
cd src/github.com/tealeg
135+
git checkout v1.0.5
136+
cd
137+
```
138+
139+
Using `go get` to install datatools using v1.0.5 of xlsx.
140+
141+
```
142+
go get github.com/caltechlibrary/datatools/...
130143
```
131144

132-
Or clone the repstory and then compile
145+
Or clone the repository and then compile
133146

134147
```shell
135148
cd
@@ -140,4 +153,3 @@ Or clone the repstory and then compile
140153
make install
141154
```
142155

143-

‎README.md‎

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,15 @@
11

22
# datatools
33

4-
_datatools_ provides a variety of command line programs for working with data in different formats as well as to ease
5-
Posix shell scripting (e.g. writing scripts that run under Bash). The tools are group as data, strings and scripting.
4+
_datatools_ provides a variety of command line programs for working with
5+
data in different formats as well as to ease Posix shell scripting
6+
(e.g. writing scripts that run under Bash). The tools are group as data,
7+
strings and scripting.
68

79
## For data
810

9-
Command line utilities for simplifying work with CSV, JSON, TOML, YAML, Excel Workbooks and plain text files or content.
11+
Command line utilities for simplifying work with CSV, JSON, TOML, YAML,
12+
Excel Workbooks and plain text files or content.
1013

1114
+ [csv2json](docs/csv2json/) - a tool to take a CSV file and convert it into a JSON array or a list of JSON blobs one per line
1215
+ [csv2mdtable](docs/csv2mdtable/) - a tool to render CSV as a Github Flavored Markdown table
@@ -35,12 +38,15 @@ Use "-help" option for a full list of options for each utility (e.g. `csv2json -
3538

3639
## For strings
3740

38-
_datatools_ provides the [string](docs/string/) command for working with text strings (limited to memory available).
39-
This is commonly needed when cleanup data for analysis. The _string_ command was created for when the old Unix
40-
stand bys- grep, awk, sed, tr are unwieldly or inconvient. _string_ provides operations are common in most language
41-
like, trimming, spliting, and transforming letter case. The _string_ command also makes it easy to join
42-
JSON string arrays into single a string using a delimiter or split a string into a JSON array
43-
based on a delimiter. The form of the command is `string [OPTIONS] [ACTION] [ARCTION_PARAMETERS...]`
41+
_datatools_ provides the [string](docs/string/) command for working with
42+
text strings (limited to memory available). This is commonly needed when
43+
cleanup data for analysis. The _string_ command was created for when the
44+
old Unix standbys- grep, awk, sed, tr are unwieldly or inconvient.
45+
_string_ provides operations are common in most language like, trimming,
46+
spliting, and transforming letter case. The _string_ command also makes
47+
it easy to join JSON string arrays into single a string using a delimiter
48+
or split a string into a JSON array based on a delimiter. The form of the
49+
command is `string [OPTIONS] [ACTION] [ARCTION_PARAMETERS...]`
4450

4551
```shell
4652
string toupper "one two three"
@@ -78,12 +84,6 @@ Use the utilities try "-help" option for a full list of options.
7884

7985
## Installation
8086

81-
See [INSTALL.md](install/) for details for installing pre-compiled versions of the programs.
82-
83-
_datatools_ are go get-able. If you have go v1.12 (or newer) you can install with the command below.
84-
85-
```
86-
go get github.com/caltechlibrary/datatools/...
87-
```
88-
87+
See [INSTALL.md](install.html) for details for installing pre-compiled
88+
versions of the programs.
8989

‎index.html‎

Lines changed: 17 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -25,12 +25,15 @@
2525
<section>
2626
<h1>datatools</h1>
2727

28-
<p><em>datatools</em> provides a variety of command line programs for working with data in different formats as well as to ease
29-
Posix shell scripting (e.g. writing scripts that run under Bash). The tools are group as data, strings and scripting.</p>
28+
<p><em>datatools</em> provides a variety of command line programs for working with
29+
data in different formats as well as to ease Posix shell scripting
30+
(e.g. writing scripts that run under Bash). The tools are group as data,
31+
strings and scripting.</p>
3032

3133
<h2>For data</h2>
3234

33-
<p>Command line utilities for simplifying work with CSV, JSON, TOML, YAML, Excel Workbooks and plain text files or content.</p>
35+
<p>Command line utilities for simplifying work with CSV, JSON, TOML, YAML,
36+
Excel Workbooks and plain text files or content.</p>
3437

3538
<ul>
3639
<li><a href="docs/csv2json/">csv2json</a> - a tool to take a CSV file and convert it into a JSON array or a list of JSON blobs one per line</li>
@@ -60,12 +63,15 @@ <h2>For data</h2>
6063

6164
<h2>For strings</h2>
6265

63-
<p><em>datatools</em> provides the <a href="docs/string/">string</a> command for working with text strings (limited to memory available).
64-
This is commonly needed when cleanup data for analysis. The <em>string</em> command was created for when the old Unix
65-
stand bys- grep, awk, sed, tr are unwieldly or inconvient. <em>string</em> provides operations are common in most language
66-
like, trimming, spliting, and transforming letter case. The <em>string</em> command also makes it easy to join
67-
JSON string arrays into single a string using a delimiter or split a string into a JSON array
68-
based on a delimiter. The form of the command is <code>string [OPTIONS] [ACTION] [ARCTION_PARAMETERS...]</code></p>
66+
<p><em>datatools</em> provides the <a href="docs/string/">string</a> command for working with
67+
text strings (limited to memory available). This is commonly needed when
68+
cleanup data for analysis. The <em>string</em> command was created for when the
69+
old Unix standbys- grep, awk, sed, tr are unwieldly or inconvient.
70+
<em>string</em> provides operations are common in most language like, trimming,
71+
spliting, and transforming letter case. The <em>string</em> command also makes
72+
it easy to join JSON string arrays into single a string using a delimiter
73+
or split a string into a JSON array based on a delimiter. The form of the
74+
command is <code>string [OPTIONS] [ACTION] [ARCTION_PARAMETERS...]</code></p>
6975

7076
<pre><code class="language-shell"> string toupper &quot;one two three&quot;
7177
</code></pre>
@@ -105,12 +111,8 @@ <h2>For scripting</h2>
105111

106112
<h2>Installation</h2>
107113

108-
<p>See <a href="install/">INSTALL.md</a> for details for installing pre-compiled versions of the programs.</p>
109-
110-
<p><em>datatools</em> are go get-able. If you have go v1.12 (or newer) you can install with the command below.</p>
111-
112-
<pre><code> go get github.com/caltechlibrary/datatools/...
113-
</code></pre>
114+
<p>See <a href="install.html">INSTALL.md</a> for details for installing pre-compiled
115+
versions of the programs.</p>
114116

115117
</section>
116118

‎install.html‎

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ <h2>The basic recipe</h2>
8181
<ul>
8282
<li>(e.g. if you&rsquo;re on a Windows 10 laptop/Surface with a amd64 style CPU you&rsquo;d choose the Zip file with &ldquo;windows-amd64&rdquo; in the name).</li>
8383
</ul></li>
84-
<li>Download the zip file and unzip the file.<br />
84+
<li>Download the zip file and unzip the file.<br>
8585
</li>
8686
<li>Copy the contents of the folder named &ldquo;bin&rdquo; to a folder that is in your path
8787

@@ -181,13 +181,25 @@ <h3>Raspberry Pi</h3>
181181

182182
<h2>Compiling from source</h2>
183183

184-
<p><em>datatools</em> is &ldquo;go gettable&rdquo;. Use the &ldquo;go get&rdquo; command to download the dependant packages
184+
<p><em>datatools</em> is &ldquo;go gettable&rdquo; if you have gotten xlsx v1.0.5 package from <a href="https://github.com/tealeg/xlsx">github.com/tealeg/xlsx</a>. The datatools package does not support versions v2.x and greater of xlsx. Below are the steps
185+
I use today with &ldquo;go get&rdquo; command to download the dependant packages
185186
as well as <em>datatools</em>&rsquo;s source code.</p>
186187

187-
<pre><code class="language-shell"> go get -u github.com/caltechlibrary/datatools/...
188+
<p>Setting up the right version of xlsx for datatools</p>
189+
190+
<pre><code class="language-shell"> cd
191+
go get github.com/tealeg/xlsx
192+
cd src/github.com/tealeg
193+
git checkout v1.0.5
194+
cd
195+
</code></pre>
196+
197+
<p>Using <code>go get</code> to install datatools using v1.0.5 of xlsx.</p>
198+
199+
<pre><code> go get github.com/caltechlibrary/datatools/...
188200
</code></pre>
189201

190-
<p>Or clone the repstory and then compile</p>
202+
<p>Or clone the repository and then compile</p>
191203

192204
<pre><code class="language-shell"> cd
193205
git clone https://github.com/caltechlibrary/datatools src/github.com/caltechlibrary/datatools

0 commit comments

Comments
 (0)