Skip to content

Commit 86f988c

Browse files
committed
docs: Clean up Readme and fix link in technical details page
1 parent b40bcd2 commit 86f988c

2 files changed

Lines changed: 7 additions & 18 deletions

File tree

README.md

Lines changed: 6 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,24 @@
11
# University of Alabama Libraries Scholarly API Cookbook
22

3-
[![DOI](https://img.shields.io/badge/Cite-Scholarly_API_Cookbook-crimson)](https://ua-libraries-research-data-services.github.io/UALIB_ScholarlyAPI_Cookbook/about/license-reuse.html)
3+
[![Read the book](https://img.shields.io/badge/Read-Scholarly_API_Cookbook-darkred)](https://ua-libraries-research-data-services.github.io/UALIB_ScholarlyAPI_Cookbook/)
4+
[![DOI](https://img.shields.io/badge/Cite-License_and_Reuse-white)](https://ua-libraries-research-data-services.github.io/UALIB_ScholarlyAPI_Cookbook/about/license-reuse.html)
45

56
> [!IMPORTANT]
67
> Please check the individual scholarly API documentation for current information on API usage and policies.
78
>
8-
> March 2025 - We have decided to no longer maintain the Matlab, Mathematica, Bash (except the Z39.50 Bash recipe) and C recipes and have removed them from the Scholarly API Cookbook. These archived recipes are in the [UA Libraries Scholarly API Cookbook Archive](https://github.com/UA-Libraries-Research-Data-Services/Scholarly_API_Cookbook_Archive).
9-
>
109
> November 2024 - Some R code tutorials that were originally MIT Licensed, are now licensed under the GPL-3 License to comply with the licensing terms of dependent R libraries.
1110
12-
The University of Alabama Libraries Scholarly API Cookbook is an open online book containing short scholarly API code examples (i.e., recipes) that demonstrate how to work with various scholarly web service APIs. It is part of the University of Alabama Libraries efforts to support Research Data Services. Read the book [here](https://ua-libraries-research-data-services.github.io/UALIB_ScholarlyAPI_Cookbook).
11+
The University of Alabama Libraries Scholarly API Cookbook is an open online book containing short scholarly API code examples (i.e., "recipes") that demonstrate how to work with various scholarly web service APIs. It is part of the University of Alabama Libraries efforts to support Research Data Services. Read the book [here](https://ua-libraries-research-data-services.github.io/UALIB_ScholarlyAPI_Cookbook).
1312

1413
## License and Reuse
1514

1615
Most of the code in this repository is licensed under the [MIT License](https://github.com/UA-Libraries-Research-Data-Services/UALIB_ScholarlyAPI_Cookbook/blob/main/LICENSE).
1716

1817
The Python scripts in this repository are licensed under the MIT License. However, these scripts may rely on external libraries such as matplotlib, pandas, and others. These libraries are licensed under their own respective terms and need to be installed separately. Refer to the documentation of each library for installation instructions and licensing details.
1918

20-
The Bash tutorials are licensed under the MIT License (Bash itself is licensed under the GNU General Public License). Some of the included scripts may rely on external tools such as curl, jq, YAZ, and gnuplot, each of which is licensed under its own terms. Users must obtain and install these tools separately. Refer to the documentation of each tool for installation instructions and licensing details.
19+
Most of the R tutorial scripts are MIT licensed, but some are licensed under the [GPL-3 License](https://github.com/UA-Libraries-Research-Data-Services/UALIB_ScholarlyAPI_Cookbook/blob/main/LICENSE_selected_R_tutorials) because they depend on GPL-licensed R libraries (refer to the documentation of each R library for installation instructions and licensing details). The R tutorials with GPL-3 licenses are indicated at the top of the respective files and organized separately in the `src/r-gpl3/` folder.
2120

22-
Lastly, most of the R tutorial scripts are MIT licensed, but some are licensed under the [GPL-3 License](https://github.com/UA-Libraries-Research-Data-Services/UALIB_ScholarlyAPI_Cookbook/blob/main/LICENSE_selected_R_tutorials) because they depend on GPL-licensed R libraries (refer to the documentation of each R library for installation instructions and licensing details). The R tutorials with GPL-3 licenses are indicated at the top of the respective files and organized separately in the folder `src/r-gpl3/`.
21+
Lastly, the Z39.50 bash tutorial is licensed under the MIT License (Bash itself is licensed under the GNU General Public License). This tutorial relies on YAZ, which is licensed under its own terms. Users must obtain and install this tool separately. Refer to the documentation of each tool for installation instructions and licensing details.
2322

2423
We have endeavored to follow the appropriate terms and usage policies of each scholarly API, web service, and Z39.50 server. We have linked to the terms and policies where possible. Some database APIs may require a valid library subscription, institutional access, or individual account to use their services. Please be responsible when reusing these scripts and respect the API terms and usage policies (e.g., query limits, record downloads, data sharing restrictions). Data output snippets shown in this book are for demonstration purposes and are credited to the individual API or database service. The output generated from APIs or services remains subject to the terms and conditions of the respective provider. Some outputs (e.g., U.S. Government works) may be in the public domain, while others may require attribution or adherence to other conditions.
2524

@@ -48,14 +47,4 @@ Citation: Scalfani, V. F.; Walker, K. W.; Simpson, L.; Fernandez, A. M.; Patel,
4847

4948
## Archived Recipes
5049

51-
We have decided to no longer maintain the Matlab, Mathematica, Bash (except the Z39.50 Bash recipe), and C recipes and have removed them from the Scholarly API Cookbook. These archived recipes are still in the [UA Libraries Scholarly API Cookbook Archive](https://github.com/UA-Libraries-Research-Data-Services/Scholarly_API_Cookbook_Archive).
52-
53-
### Archive License Information
54-
55-
The code in the UA Libraries Scholarly API Cookbook Archive is licensed under the [MIT License](https://github.com/UA-Libraries-Research-Data-Services/Scholarly_API_Cookbook_Archive/blob/main/LICENSE). This includes code written to be used with Wolfram Mathematica and MathWorks MATLAB. However, these proprietary software packages themselves are not covered under the MIT License, and users must have valid licenses for Mathematica and MATLAB to run the associated code.
56-
57-
The Python scripts in this repository are licensed under the MIT License. However, these scripts may rely on external libraries such as matplotlib, pandas, and others. These libraries are licensed under their own respective terms and need to be installed separately. Refer to the documentation of each library for installation instructions and licensing details.
58-
59-
The Bash tutorials are licensed under the MIT License (Bash itself is licensed under the GNU General Public License). Some of the included scripts may rely on external tools such as curl, jq, and gnuplot, each of which is licensed under its own terms. Users must obtain and install these tools separately. Refer to the documentation of each tool for installation instructions and licensing details.
60-
61-
The C code in the archive is licensed under the MIT License. This repository provides only the source code, and users will need to compile the C programs to run them. Some of the C code depends on external libraries such as curl, jq, and YAZ, which are licensed under their own respective terms. These libraries will need to be obtained and installed separately by the user.
50+
As of March 2025, we have decided to no longer maintain the Matlab, Mathematica, Bash (except the Z39.50 Bash recipe), and C recipes and have removed them from the Scholarly API Cookbook. These archived recipes are still in the [UA Libraries Scholarly API Cookbook Archive](https://github.com/UA-Libraries-Research-Data-Services/Scholarly_API_Cookbook_Archive). Please see the archive repo for more information about the licensing of old Cookbook recipes.

src/about/tech-details.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,5 +12,5 @@ Technology and Software Used
1212

1313
.. _Jupyter Notebooks: https://jupyter.org/
1414
.. _reStructuredText: https://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html
15-
.. _Jupyter Book: https://jupyterbook.org/intro.html
15+
.. _Jupyter Book: https://jupyterbook.org/
1616
.. _GitHub Actions: https://docs.github.com/en/actions

0 commit comments

Comments
 (0)