Add ability to authenticate with a JWT loaded from a file.

Author: aaronweeden

CHANGELOG.md

@@ -6,8 +6,8 @@
 - Implement 100% test coverage ([\#27](https://github.com/ubccr/xdmod-data/pull/27)).
 - Update Flake8 rules ([\#28](https://github.com/ubccr/xdmod-data/pull/28)).
 - Change to using CircleCI instead of GitHub Actions for continuous integration ([\#48](https://github.com/ubccr/xdmod-data/pull/48), [\#49](https://github.com/ubccr/xdmod-data/pull/49)).
-- Set up Docker Compose for CI testing ([\#51](https://github.com/ubccr/xdmod-data/pull/51)).
-- Add XDMoD 11.0 development version to CI testing ([\#52](https://github.com/ubccr/xdmod-data/pull/52)).
+- Set up Docker Compose for CI testing ([\#51](https://github.com/ubccr/xdmod-data/pull/51), [\#52](https://github.com/ubccr/xdmod-data/pull/52)).
+- Add ability to authenticate with a JWT loaded from a file ([\#](https://github.com/ubccr/xdmod-data/pull/)).
 
 ## v1.0.2 (2024-10-31)
 

README.md

@@ -1,7 +1,10 @@
 # xdmod-data
-As part of the Data Analytics Framework for [XDMoD](https://open.xdmod.org), this Python package provides API access to the data warehouse of instances of Open XDMoD.
+As part of the Data Analytics Framework for [XDMoD](https://open.xdmod.org),
+this Python package provides API access to the data warehouse of instances of
+Open XDMoD.
 
-This documentation is for **v2.x.y (main development branch)**. For documentation of other versions:
+This documentation is for **v2.x.y (main development branch)**. For
+documentation of other versions:
 
 - [v1.0.2](https://github.com/ubccr/xdmod-data/tree/v1.0.2?tab=readme-ov-file#xdmod-data)
 - [v1.0.1](https://github.com/ubccr/xdmod-data/tree/v1.0.1?tab=readme-ov-file#xdmod-data)
@@ -12,22 +15,35 @@ The package can be installed from PyPI via `pip install xdmod-data`.
 
 Existing installations can be upgraded via `pip install --upgrade xdmod-data`.
 
-The package has dependencies on [NumPy](https://pypi.org/project/numpy/), [Pandas](https://pypi.org/project/pandas/), [Plotly](https://pypi.org/project/plotly/), and [Requests](https://pypi.org/project/requests/).
+The package has dependencies on [NumPy](https://pypi.org/project/numpy/),
+[python-dotenv](https://pypi.org/project/python-dotenv/),
+[Pandas](https://pypi.org/project/pandas/),
+[Plotly](https://pypi.org/project/plotly/), and
+[Requests](https://pypi.org/project/requests/).
 
-Example usage is documented through Jupyter notebooks in the [xdmod-notebooks](https://github.com/ubccr/xdmod-notebooks) repository.
+Example usage is documented through Jupyter notebooks in the
+[xdmod-notebooks](https://github.com/ubccr/xdmod-notebooks) repository.
 
 ## Compatibility with Open XDMoD
-Specific versions of this package are compatible with specific versions of Open XDMoD as indicated in the table below.
+Specific versions of this package are compatible with specific versions of Open
+XDMoD as indicated in the table below.
 
 | `xdmod-data` version | Open XDMoD versions |
 | -------------------- | ------------------- |
 | 1.0.2, 1.0.1         | 11.0.x, 10.5.x      |
 | 1.0.0                | 10.5.x              |
 
-## API Token Access
-Use of the Data Analytics Framework requires an API token. To obtain an API token, follow the steps below to obtain an API token from the XDMoD portal.
+## API Token or JupyterHub Access
+Use of the Data Analytics Framework requires an API token, unless you are
+running in an XDMoD-hosted JupyterHub such as the one provided by ACCESS XDMoD
+(https://xdmod.access-ci.org/jupyter-hub), in which case authentication is
+handled automatically.
 
-1. First, if you are not already signed in to the portal, sign in in the top-left corner:
+If you need to obtain an API token, you can follow the steps below to obtain
+one from the XDMoD portal.
+
+1. First, if you are not already signed in to the portal, sign in in the
+   top-left corner:
 
     ![Screenshot of "Sign In" button](https://raw.githubusercontent.com/ubccr/xdmod-data/main/docs/images/api-token/sign-in.jpg)
 
@@ -49,17 +65,21 @@ Use of the Data Analytics Framework requires an API token. To obtain an API toke
 
     ![Screenshot of "Generate API Token" button](https://raw.githubusercontent.com/ubccr/xdmod-data/main/docs/images/api-token/generate.jpg)
 
-1. Copy the token to your clipboard. Make sure to paste it somewhere secure for saving, as you will not be able to see the token again once you close the window:
+1. Copy the token to your clipboard. Make sure to paste it somewhere secure for
+   saving, as you will not be able to see the token again once you close the
+   window:
 
     ![Screenshot of "Copy API Token to Clipboard" button](https://raw.githubusercontent.com/ubccr/xdmod-data/main/docs/images/api-token/copy.jpg)
 
     **Note:** If you lose your token, simply delete it and generate a new one.
 
 ## Feedback / Feature Requests
-We welcome your feedback and feature requests for the Data Analytics Framework for XDMoD via email: ccr-xdmod-help@buffalo.edu.
+We welcome your feedback and feature requests for the Data Analytics Framework
+for XDMoD via email: ccr-xdmod-help@buffalo.edu.
 
 ## Support
-For support, please see [this page](https://open.xdmod.org/support.html). If you email for support, please include the following:
+For support, please see [this page](https://open.xdmod.org/support.html). If
+you email for support, please include the following:
 * `xdmod-data` version number, obtained by running this Python code:
     ```
     from xdmod_data import __version__
@@ -70,15 +90,24 @@ For support, please see [this page](https://open.xdmod.org/support.html). If you
 * Detailed steps to reproduce the problem.
 
 ## License
-`xdmod-data` is released under the GNU Lesser General Public License ("LGPL") Version 3.0. See the [LICENSE](LICENSE) file for details.
+`xdmod-data` is released under the GNU Lesser General Public License ("LGPL")
+Version 3.0. See the [LICENSE](LICENSE) file for details.
 
 ## References
 
-When referencing the Data Analytics Framework for XDMoD, please cite the following publication:
+When referencing the Data Analytics Framework for XDMoD, please cite the
+following publication:
 
-> Weeden, A., White, J.P., DeLeon, R.L., Rathsam, R., Simakov, N.A., Saeli, C., and Furlani, T.R. The Data Analytics Framework for XDMoD. _SN COMPUT. SCI._ 5, 462 (2024). https://doi.org/10.1007/s42979-024-02789-2
+> Weeden, A., White, J.P., DeLeon, R.L., Rathsam, R., Simakov, N.A., Saeli, C.,
+  and Furlani, T.R. The Data Analytics Framework for XDMoD. _SN COMPUT. SCI._
+  5, 462 (2024). https://doi.org/10.1007/s42979-024-02789-2
 
 When referencing XDMoD, please cite the following publication:
 
-> Jeffrey T. Palmer, Steven M. Gallo, Thomas R. Furlani, Matthew D. Jones, Robert L. DeLeon, Joseph P. White, Nikolay Simakov, Abani K. Patra, Jeanette Sperhac, Thomas Yearke, Ryan Rathsam, Martins Innus, Cynthia D. Cornelius, James C. Browne, William L. Barth, Richard T. Evans, "Open XDMoD: A Tool for the Comprehensive Management of High-Performance Computing Resources", *Computing in Science & Engineering*, Vol 17, Issue 4, 2015, pp. 52-62. DOI:[10.1109/MCSE.2015.68](https://doi.org/10.1109/MCSE.2015.68)
-
+> Jeffrey T. Palmer, Steven M. Gallo, Thomas R. Furlani, Matthew D. Jones,
+  Robert L. DeLeon, Joseph P. White, Nikolay Simakov, Abani K. Patra, Jeanette
+  Sperhac, Thomas Yearke, Ryan Rathsam, Martins Innus, Cynthia D. Cornelius,
+  James C. Browne, William L. Barth, Richard T. Evans, "Open XDMoD: A Tool for
+  the Comprehensive Management of High-Performance Computing Resources",
+  *Computing in Science & Engineering*, Vol 17, Issue 4, 2015, pp. 52-62.
+  DOI:[10.1109/MCSE.2015.68](https://doi.org/10.1109/MCSE.2015.68)