-
--This is a go package for working with the CrossRef API. It is inspired by the an excellent CrossRefAPI Python package listed in the CrossRef API docs. This package is meant to follow the “polite” guidelines for interacting with the public API at api.crossref.org. -
- client, err := crossrefapi.NewCrossRefClient("jane.doe@library.example.edu")
- if err != nil {
- // handle error...
- }
- works, err := client.Works("10.1037/0003-066x.59.1.29")
-
- if err != nil {
- // handle error...
- }
- // continue processing your "works" result... crossrefapi -mailto="jane.doe@library.example.edu" works "10.1037/0003-066x.59.1.29"-crossrefapi is a command line program run from a shell like Bash. It allows you to retrieve JSON works and types object from the CrossRefAPI in a polite manner. -
--This is generalized instructions for a release. For deployment suggestions see NOTES.md -
--Compiled versions are available for Mac OS X (amd64 and M1 processor, macos-amd64, macos-arm64), Linux (amd64 process, linux-amd64), Windows (amd64 processor, windows-amd64) and Rapsberry Pi (arm7 processor, raspbian-arm7) -
--VERSION_NUMBER is a symantic version number (e.g. v0.1.2) -
--For all the released version go to the project page on Github and click latest release -
----https://github.com/caltechlibrary/crossrefapi/releases/latest -
-
| -Platform - | --Zip Filename - | -
|---|---|
| -Windows - | --crossrefapi-VERSION_NUMBER-windows-amd64.zip - | -
| -Mac OS X - | --crossrefapi-VERSION_NUMBER-macos-amd64.zip - | -
| -Mac OS X - | --crossrefapi-VERSION_NUMBER-macos-arm64.zip - | -
| -Linux/Intel - | --crossrefapi-VERSION_NUMBER-linux-amd64.zip - | -
| -Raspbery Pi - | --crossrefapi-VERSION_NUMBER-raspbian-arm7.zip - | -
-Here’s an example of the commands run in the Terminal App after downloading the zip file. -
- cd Downloads/
- unzip crossrefapi-*-macos-amd64.zip
- mkdir -p $HOME/bin
- cp -v bin/* $HOME/bin/
- export PATH=$HOME/bin:$PATH
- crossrefapi -version-Here’s an example of the commands run in from the Bash shell on Windows 10 after downloading the zip file. -
- cd Downloads/
- unzip crossrefapi-*-windows-amd64.zip
- mkdir -p $HOME/bin
- cp -v bin/* $HOME/bin/
- export PATH=$HOME/bin:$PATH
- crossrefapi -version-Here’s an example of the commands run in from the Bash shell after downloading the zip file. -
- cd Downloads/
- unzip crossrefapi-*-linux-amd64.zip
- mkdir -p $HOME/bin
- cp -v bin/* $HOME/bin/
- export PATH=$HOME/bin:$PATH
- crossrefapi -version-Released version is for a Raspberry Pi 2 or later use (i.e. requires ARM 7 support). -
--Here’s an example of the commands run in from the Bash shell after downloading the zip file. -
- cd Downloads/
- unzip crossrefapi-*-raspbian-arm7.zip
- mkdir -p $HOME/bin
- cp -v bin/* $HOME/bin/
- export PATH=$HOME/bin:$PATH
- crossrefapi -version-crossrefapi is “go gettable”. Use the “go get” command to download the dependant packages as well as crossrefapi’s source code. -
- go get -u github.com/caltechlibrary/crossrefapi/...-Or clone the repstory and then compile -
- cd
- git clone https://github.com/caltechlibrary/crossrefapi src/github.com/caltechlibrary/crossrefapi
- cd src/github.com/caltechlibrary/crossrefapi
- make
- make test
- make install-Compilation assumes go v1.16 -
-
--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: -
--Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. -
--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. -
--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. -
-