Skip to content

Commit

Permalink
Merge pull request #10 from ualibweb/add_citation
Browse files Browse the repository at this point in the history
add manuscript reference and update tech details.
  • Loading branch information
vfscalfani authored Oct 13, 2023
2 parents a21b9af + 71e2fb8 commit d2620c9
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 14 deletions.
33 changes: 23 additions & 10 deletions content/about/license_reuse.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,14 +21,27 @@ can be found in the GitHub repository:
for demonstration purposes and credited to the individual API or database service.


If you reuse the code, attribution would be appreciated. Please cite this resource with the following information:

- Author Name
- Title of Cookbook page
- Title of resource (i.e., The University of Alabama Libraries Scholarly API Cookbook)
- Date
- Link to Cookbook: `<https://ualibweb.github.io/UALIB_ScholarlyAPI_Cookbook/>`_

Here is an example:
If you reuse the code, attribution would be appreciated. Please link to the Cookbook and cite our manuscript:

Link to Cookbook: `<https://ualibweb.github.io/UALIB_ScholarlyAPI_Cookbook/>`_

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>`_.

.. code-block:: bibtex
@article{scalfani_creating_2023,
title = {Creating a {Scholarly} {API} {Cookbook}: {Supporting} {Library} {Users} with {Programmatic} {Access} to {Information}},
issn = {1092-1206},
shorttitle = {Creating a {Scholarly} {API} {Cookbook}},
url = {https://journals.library.ualberta.ca/istl/index.php/istl/article/view/2766},
doi = {10.29173/istl2766},
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.},
number = {104},
urldate = {2023-10-13},
journal = {Issues in Science and Technology Librarianship},
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.},
month = oct,
year = {2023},
}
Scalfani, V.F. Scopus API in Python, The University of Alabama Libraries Scholarly API Cookbook, 2022, `<https://ualibweb.github.io/UALIB_ScholarlyAPI_Cookbook/>`_
6 changes: 2 additions & 4 deletions content/about/tech_details.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,16 +6,14 @@ Technical Details
Technology and Software Used
*****************************

1. Python tutorial and Mathematica content (`with Wolfram Kernel`_) is written in `Jupyter Notebooks`_
1. Python, C, and Mathematica content (`with Wolfram Kernel`_) are written in `Jupyter Notebooks`_
2. All other content is written in `reStructuredText`_.
3. Code testing is done locally.
4. `Jupyter Book`_ is used to compile and create the HTML files locally.
5. The HTML content is then hosted with `GitHub Actions`_. This HTML content is pushed manually into the docs folder.
4. `Jupyter Book`_ is used to compile and create the HTML files via an automated GitHub Workflow. This workflow builds the book and hosts the HTML content with `GitHub Actions`_.

.. _with Wolfram Kernel: https://github.com/WolframResearch/WolframLanguageForJupyter
.. _Jupyter Notebooks: https://jupyter.org/
.. _reStructuredText: https://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html
.. _Jupyter Book: https://jupyterbook.org/intro.html
.. _GitHub Actions: https://docs.github.com/en/actions


0 comments on commit d2620c9

Please sign in to comment.