Skip to content

Commit 121c6c2

Browse files
committed
docs: Add Cite page
1 parent 2fcae8e commit 121c6c2

4 files changed

Lines changed: 32 additions & 42 deletions

File tree

README.md

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

33
[![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)
4+
[![DOI](https://img.shields.io/badge/Cite-gray)](https://ua-libraries-research-data-services.github.io/UALIB_ScholarlyAPI_Cookbook/about/cite.html)
55

66
> [!IMPORTANT]
77
> Please check the individual scholarly API documentation for current information on API usage and policies.
@@ -18,33 +18,14 @@ The Python scripts in this repository are licensed under the MIT License. Howeve
1818

1919
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.
2020

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.
21+
Lastly, 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.
2222

2323
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.
2424

25-
If you reuse the code, attribution would be appreciated. Please link to the Cookbook and cite our manuscript:
25+
If you reuse the code, attribution would be appreciated. Please link to the Cookbook and see the [Cite page](https://ua-libraries-research-data-services.github.io/UALIB_ScholarlyAPI_Cookbook/about/cite) for full citation information.
2626

2727
Link to Cookbook: https://ua-libraries-research-data-services.github.io/UALIB_ScholarlyAPI_Cookbook
2828

29-
Citation: Scalfani, V. F.; Walker, K. W.; Simpson, L.; Fernandez, A. M.; Patel, V. D.; Ramig, A.; Gomes, C.; Moen, M. T.; Nguyen, A. M. Creating a Scholarly API Cookbook: Supporting Library Users with Programmatic Access to Information. Issues in Science and Technology Librarianship, 2023, No. 104. https://doi.org/10.29173/istl2766.
30-
31-
```bibtex
32-
@article{scalfani_creating_2023,
33-
title = {Creating a {Scholarly} {API} {Cookbook}: {Supporting} {Library} {Users} with {Programmatic} {Access} to {Information}},
34-
issn = {1092-1206},
35-
shorttitle = {Creating a {Scholarly} {API} {Cookbook}},
36-
url = {https://journals.library.ualberta.ca/istl/index.php/istl/article/view/2766},
37-
doi = {10.29173/istl2766},
38-
abstract = {Scholarly web-based application programming interfaces (APIs) allow users to interact with information and data programmatically. Interacting with information programmatically allows users to create advanced information query workflows and quickly access machine-readable data for downstream computations. With the growing availability of scholarly APIs from open and commercial library databases, supporting access to information via an API has become a key support area for research data services in libraries. This article describes our efforts with supporting API access through the development of an online Scholarly API Cookbook. The Cookbook contains code recipes (i.e., tutorials) for getting started with 10 different scholarly APIs, including for example, Scopus, World Bank, and PubMed. API tutorials are available in Python, Bash, Matlab, and Mathematica. A tutorial for interacting with library catalog data programmatically via Z39.50 is also included, as traditional library catalog metadata is rarely available via an API. In addition to describing the Scholarly API Cookbook content, we discuss our experiences building a student research data services programming team, challenges we encountered, and ideas to improve the Cookbook. The University of Alabama Libraries Scholarly API Cookbook is freely available and hosted on GitHub. All code within the API Cookbook is licensed with the permissive MIT license, and as a result, users are free to reuse and adapt the code in their teaching and research.},
39-
number = {104},
40-
urldate = {2023-10-13},
41-
journal = {Issues in Science and Technology Librarianship},
42-
author = {Scalfani, Vincent F. and Walker, Kevin W. and Simpson, Lance and Fernandez, Avery M. and Patel, Vishank D. and Ramig, Anastasia and Gomes, Cyrus and Moen, Michael T. and Nguyen, Adam M.},
43-
month = oct,
44-
year = {2023},
45-
}
46-
```
47-
4829
## Archived Recipes
4930

5031
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/_toc.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -278,5 +278,6 @@ parts:
278278
- caption: ABOUT
279279
chapters:
280280
- file: about/history
281+
- file: about/cite
281282
- file: about/contributing # Note: This page redirects to CONTRIBUTING.md
282283
- file: about/license-reuse

src/about/cite.rst

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
Citing the Cookbook
2+
%%%%%%%%%%%%%%%%%%%%
3+
4+
If you reuse the code, attribution would be appreciated. Please link to the Cookbook and cite our manuscript:
5+
6+
Link to Cookbook: `<https://ua-libraries-research-data-services.github.io/UALIB_ScholarlyAPI_Cookbook>`_
7+
8+
Citation: Scalfani, V. F.; Walker, K. W.; Simpson, L.; Fernandez, A. M.; Patel, V. D.; Ramig, A.; Gomes, C.; Moen, M. T.; Nguyen, A. M. Creating a Scholarly API Cookbook: Supporting Library Users with Programmatic Access to Information. *Issues in Science and Technology Librarianship*, **2023**, No. 104. `<https://doi.org/10.29173/istl2766>`_.
9+
10+
.. code-block:: bibtex
11+
12+
@article{scalfani_creating_2023,
13+
title = {Creating a {Scholarly} {API} {Cookbook}: {Supporting} {Library} {Users} with {Programmatic} {Access} to {Information}},
14+
issn = {1092-1206},
15+
shorttitle = {Creating a {Scholarly} {API} {Cookbook}},
16+
url = {https://journals.library.ualberta.ca/istl/index.php/istl/article/view/2766},
17+
doi = {10.29173/istl2766},
18+
abstract = {Scholarly web-based application programming interfaces (APIs) allow users to interact with information and data programmatically. Interacting with information programmatically allows users to create advanced information query workflows and quickly access machine-readable data for downstream computations. With the growing availability of scholarly APIs from open and commercial library databases, supporting access to information via an API has become a key support area for research data services in libraries. This article describes our efforts with supporting API access through the development of an online Scholarly API Cookbook. The Cookbook contains code recipes (i.e., tutorials) for getting started with 10 different scholarly APIs, including for example, Scopus, World Bank, and PubMed. API tutorials are available in Python, Bash, Matlab, and Mathematica. A tutorial for interacting with library catalog data programmatically via Z39.50 is also included, as traditional library catalog metadata is rarely available via an API. In addition to describing the Scholarly API Cookbook content, we discuss our experiences building a student research data services programming team, challenges we encountered, and ideas to improve the Cookbook. The University of Alabama Libraries Scholarly API Cookbook is freely available and hosted on GitHub. All code within the API Cookbook is licensed with the permissive MIT license, and as a result, users are free to reuse and adapt the code in their teaching and research.},
19+
number = {104},
20+
urldate = {2023-10-13},
21+
journal = {Issues in Science and Technology Librarianship},
22+
author = {Scalfani, Vincent F. and Walker, Kevin W. and Simpson, Lance and Fernandez, Avery M. and Patel, Vishank D. and Ramig, Anastasia and Gomes, Cyrus and Moen, Michael T. and Nguyen, Adam M.},
23+
month = oct,
24+
year = {2023},
25+
}
26+
27+
:download:`Download CITATION.bib <../../CITATION.bib>`

src/about/license-reuse.rst

Lines changed: 1 addition & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -16,28 +16,9 @@ Lastly, most of the R tutorial scripts are MIT licensed, but some are licensed u
1616

1717
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.
1818

19-
If you reuse the code, attribution would be appreciated. Please link to the Cookbook and cite our manuscript:
19+
If you reuse the code, attribution would be appreciated. Please link to the Cookbook and see the :doc:`Cite page </about/cite>` for full citation information.
2020

2121
Link to Cookbook: `<https://ua-libraries-research-data-services.github.io/UALIB_ScholarlyAPI_Cookbook>`_
22-
23-
Citation: Scalfani, V. F.; Walker, K. W.; Simpson, L.; Fernandez, A. M.; Patel, V. D.; Ramig, A.; Gomes, C.; Moen, M. T.; Nguyen, A. M. Creating a Scholarly API Cookbook: Supporting Library Users with Programmatic Access to Information. *Issues in Science and Technology Librarianship*, **2023**, No. 104. `<https://doi.org/10.29173/istl2766>`_.
24-
25-
.. code-block:: bibtex
26-
27-
@article{scalfani_creating_2023,
28-
title = {Creating a {Scholarly} {API} {Cookbook}: {Supporting} {Library} {Users} with {Programmatic} {Access} to {Information}},
29-
issn = {1092-1206},
30-
shorttitle = {Creating a {Scholarly} {API} {Cookbook}},
31-
url = {https://journals.library.ualberta.ca/istl/index.php/istl/article/view/2766},
32-
doi = {10.29173/istl2766},
33-
abstract = {Scholarly web-based application programming interfaces (APIs) allow users to interact with information and data programmatically. Interacting with information programmatically allows users to create advanced information query workflows and quickly access machine-readable data for downstream computations. With the growing availability of scholarly APIs from open and commercial library databases, supporting access to information via an API has become a key support area for research data services in libraries. This article describes our efforts with supporting API access through the development of an online Scholarly API Cookbook. The Cookbook contains code recipes (i.e., tutorials) for getting started with 10 different scholarly APIs, including for example, Scopus, World Bank, and PubMed. API tutorials are available in Python, Bash, Matlab, and Mathematica. A tutorial for interacting with library catalog data programmatically via Z39.50 is also included, as traditional library catalog metadata is rarely available via an API. In addition to describing the Scholarly API Cookbook content, we discuss our experiences building a student research data services programming team, challenges we encountered, and ideas to improve the Cookbook. The University of Alabama Libraries Scholarly API Cookbook is freely available and hosted on GitHub. All code within the API Cookbook is licensed with the permissive MIT license, and as a result, users are free to reuse and adapt the code in their teaching and research.},
34-
number = {104},
35-
urldate = {2023-10-13},
36-
journal = {Issues in Science and Technology Librarianship},
37-
author = {Scalfani, Vincent F. and Walker, Kevin W. and Simpson, Lance and Fernandez, Avery M. and Patel, Vishank D. and Ramig, Anastasia and Gomes, Cyrus and Moen, Michael T. and Nguyen, Adam M.},
38-
month = oct,
39-
year = {2023},
40-
}
4122

4223
Scholarly API Cookbook Archive
4324
******************************

0 commit comments

Comments
 (0)