Skip to content

Commit 5473b65

Browse files
dachambersdachambers
authored
Merge pull request #171 from UA-Libraries-Research-Data-Services/update-readme
docs: Update README and Introduction
2 parents 9e9af05 + 4bb92d6 commit 5473b65

4 files changed

Lines changed: 18 additions & 28 deletions

File tree

‎README.md‎

Lines changed: 1 addition & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -12,19 +12,7 @@ The University of Alabama Libraries Scholarly API Cookbook is an open online boo
1212

1313
## License and Reuse
1414

15-
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).
16-
17-
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.
18-
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.
20-
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.
22-
23-
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.
24-
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.
26-
27-
Link to Cookbook: https://ua-libraries-research-data-services.github.io/UALIB_ScholarlyAPI_Cookbook
15+
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), but some of the R tutorial scripts are under the [GPL-3 License](https://github.com/UA-Libraries-Research-Data-Services/UALIB_ScholarlyAPI_Cookbook/blob/main/LICENSE_selected_R_tutorials). Please see the [License and Reuse page](https://ua-libraries-research-data-services.github.io/UALIB_ScholarlyAPI_Cookbook/about/license-reuse) for more information about licensing and reuse. 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. 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.
2816

2917
## Archived Recipes
3018

‎src/_templates/layout.html‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,7 @@
44
{% set site_name = "University of Alabama Libraries Scholarly API Cookbook" %}
55
{% set base = (html_baseurl or "https://ua-libraries-research-data-services.github.io/UALIB_ScholarlyAPI_Cookbook/") %}
66
{% set page_url = base ~ pagename ~ ('' if pagename.endswith('.html') else '.html') %}
7-
<!-- Canonical Link and Sitemap -->
8-
<link rel="canonical" href="{{ page_url }}" />
7+
<!-- Sitemap -->
98
<link rel="sitemap" type="application/xml" title="Sitemap" href="{{ base }}sitemap.xml">
109
{% set og_title = title|striptags %}
1110
{% set site_desc = "Example tutorials for working with scholarly APIs for academic research and teaching using Python and R." %}

‎src/about/introduction.rst‎

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -58,13 +58,19 @@ While there may be some introductory programming content in this book, the
5858
content is not meant to be a general introduction to programming.
5959
Instead, our aim with the Scholarly API Cookbook is to provide
6060
some short scripting based workflows for working with scholarly data and information APIs.
61-
For more general introductions to programming, we recommend searching the
62-
UA Libraries Scout database for programming books (e.g., `TI python`).
61+
For more general introductions to programming, we recommend searching your institution's
62+
library catalog or discovery service for introductory books on programming
63+
(e.g., for UA Libraries, try `Scout`_). See also the `UA Libraries Research Computing Services Guide`_.
64+
65+
.. _Scout: https://research.ebsco.com/c/2cdwag/search
66+
.. _UA Libraries Research Computing Services Guide: https://guides.lib.ua.edu/RCS/generalprogramming
6367

6468
.. seealso::
6569

66-
UA Libraries Workshop lessons and references therein for more general
67-
programming content [#ua_work]_.
70+
UA Libraries teaches a variety of computing related workshops, including introductions to
71+
general programming. See our `workshop calendar`_ for more information.
72+
73+
.. _workshop calendar: https://ua.libcal.com/
6874

6975
What programming languages are covered?
7076
****************************************
@@ -91,8 +97,5 @@ Who is creating the content?
9197

9298
The Scholarly API Cookbook content is authored by University of Alabama
9399
Libraries faculty and student assistants. Specific authors are noted on each
94-
tutorial or document page.
95-
96-
.. rubric:: References
97-
98-
.. [#ua_work] `<https://github.com/UA-Libraries-Research-Data-Services/UALIB_Workshops>`_
100+
tutorial or document page. See the :doc:`History page <history>` for more information
101+
on the site's history and contributors.

‎src/about/license-reuse.rst‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ License and Reuse
44
License and Reuse
55
******************
66

7-
Most of the code in this Scholarly API Cookbook is licensed under the `MIT License <https://github.com/UA-Libraries-Research-Data-Services/UALIB_ScholarlyAPI_Cookbook/blob/main/LICENSE>`_.
7+
Most of the code in this Scholarly API Cookbook is licensed under the `MIT License`_.
88

99
The Python scripts in this Scholarly API Cookbook 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.
1010

@@ -17,18 +17,18 @@ Lastly, most of the R tutorial scripts are MIT licensed, but some are licensed u
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

1919
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.
20-
21-
Link to Cookbook: `<https://ua-libraries-research-data-services.github.io/UALIB_ScholarlyAPI_Cookbook>`_
2220

2321
Scholarly API Cookbook Archive
2422
******************************
2523

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

28-
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.
26+
The code in the UA Libraries Scholarly API Cookbook Archive is licensed under the `MIT 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.
2927

3028
The Python scripts in this Scholarly API Cookbook 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.
3129

3230
The Bash scripts 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.
3331

3432
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.
33+
34+
.. _MIT License: https://github.com/UA-Libraries-Research-Data-Services/Scholarly_API_Cookbook_Archive/blob/main/LICENSE

0 commit comments

Comments
 (0)