Fix for inconsistency in README (#112)

* Use non-legacy import in example
* Add deprecation note for import path
* Fix import path
* Fix class name in helm chart

---------

Co-authored-by: Bengt Giger <bgiger@ethz.ch>
Co-authored-by: Martin Claus <mclaus@geomar.de>

README.md

@@ -26,6 +26,8 @@ pip install jupyterhub-ltiauthenticator
 
 ### LTI 1.1
 
+> **Note**: With release `1.1.0`, the import path of the authenticator class changed from `ltiauthenticator.LTIAuthenticator` to `ltiauthenticator.lti11.auth.LTI11Authenticator`. While the old path is still available to maintain backward compatibility, its use is deprecated and it will be removed in the next major release.
+
 #### Common Configuration Settings
 
 Due to the fact that LTI 1.1 is an open standard, Learning Management System (LMS) vendors that adhere to the LTI 1.1 standard utilize the same configuration settings when integrating with an external tool. Some of these settings are included in a configuration endpoint to facilitate the JupyterHub's as an external tool with your LMS.
@@ -103,8 +105,8 @@ hub:
     # Additional documentation related to authentication and authorization available at
     # https://zero-to-jupyterhub.readthedocs.io/en/latest/administrator/authentication.html
     JupyterHub:
-      authenticator_class: ltiauthenticator.LTIAuthenticator # LTI 1.1
-    LTIAuthenticator:
+      authenticator_class: ltiauthenticator.lti11.auth.LTI11Authenticator # LTI 1.1
+    LTI11Authenticator:
       consumers: { "client-key": "client-secret" }
       username_key: "lis_person_contact_email_primary"
       config_icon: "https://my.static.assets/img/icon.jpg"

examples/jupyterhub_config_lti11.py

@@ -19,7 +19,7 @@
 c.Authenticator.enable_auth_state = True
 
 # Set the LTI 1.1 authenticator.
-c.JupyterHub.authenticator_class = "ltiauthenticator.LTIAuthenticator"
+c.JupyterHub.authenticator_class = "ltiauthenticator.lti11.auth.LTI11Authenticator"
 
 # Add the LTI 1.1 consumer key and shared secret. Note the use of
 # `LTI11Authenticator` vs the legacy `LTIAuthenticator`.