🔀 Merge dev into master to 0.3.0

🔀 0.3.0: Merge master with dev

Author: spezian

.vscode/settings.json

@@ -1,12 +1,38 @@
 {
     "cSpell.words": [
+        "ansichten",
+        "colour",
+        "Cryptodome",
+        "cryptor",
+        "Cryptor",
+        "empf",
+        "entrys",
+        "exporteur",
+        "furo",
         "hessen",
         "httpx",
+        "inhalt",
+        "intersphinx",
+        "kalender",
+        "kategorie",
+        "kuerzel",
         "kurwjan",
         "Lanis",
+        "lanisapi",
         "levelname",
+        "meinunterricht",
+        "nachrichten",
+        "PKCS",
+        "protokoll",
+        "publickey",
         "schoolid",
-        "selectolax"
+        "selectolax",
+        "uniqid",
+        "Uniquid",
+        "unpad",
+        "Unpad",
+        "unpadded",
+        "yxxx"
     ],
     "esbonio.sphinx.confDir": ""
 }

README-DE.md

@@ -16,6 +16,7 @@ Eine inoffizielle Python-Bibliothek für das Schulportal Hessen. Auch auf [PyPi]
 + Kalenderereignisse bekommen.
 + Unterhaltungen bekommen.
 + Alle Schulen die Lanis haben bekommen.
++ Alle Online-Apps mit ihren Links bekommen.
 
 **Übersicht von zukünftigen Features, Probleme und anderes [hier](https://github.com/users/kurwjan/projects/2)**
 
@@ -25,7 +26,7 @@ Eine inoffizielle Python-Bibliothek für das Schulportal Hessen. Auch auf [PyPi]
 pip install lanisapi
 ```
 
-Vorausgesetzt wird Python 3.11. *(ältere Versionen gehen bestimmt auch, habe es nicht getestet)*
+Vorausgesetzt wird Python 3.11. *(ältere Versionen gehen wahrscheinlich nicht, habe es nicht getestet)*
 
 ## Beispiel
 
@@ -35,9 +36,9 @@ Dieses Beispiel gibt dir den Vertretungsplan.
 from lanisapi import LanisClient
 
 def main():
-    client = LanisClient("schulid", "name.nachname", "passwort")
-        or: client = LanisClient(School("school", "city"), "password")
-    client.authenticate()
+    client = LanisClient(LanisAccount("school id", "name.lastname", "password"))
+        or: client = LanisClient(LanisAccount(School("school", "city"), "name.lastname", "password"))
+        or: client = LanisClient(LanisCookie("school id", "session id"))
     print(client.get_substitution_plan())
     client.close()
 

README.md

@@ -16,6 +16,7 @@ It's an unofficial Python library for the Schulportal Hessen. Also available on
 + Fetch calendar events.
 + Fetch conversations.
 + Fetch all schools that have Lanis.
++ Fetch all web applets with their links.
 
 **Overview of future Features, Problems and other things [here](https://github.com/users/kurwjan/projects/2).**
 
@@ -25,18 +26,19 @@ It's an unofficial Python library for the Schulportal Hessen. Also available on
 pip install lanisapi
 ```
 
-Required is Python 3.11. *(older versions should definitely work too but I didn't tested it.)*
+Required is Python 3.11. *(older versions are probably not working, I didn't tested it.)*
 
 ## Example
 
 This example gives the substitution plan.
 
 ```python
-from lanisapi import LanisClient, School
+from lanisapi import LanisClient, LanisAccount, LanisCookies, School
 
 def main():
-    client = LanisClient("schoolid", "name.lastname", "password")
-        or: client = LanisClient(School("school", "city"), "password")
+    client = LanisClient(LanisAccount("school id", "name.lastname", "password"))
+        or: client = LanisClient(LanisAccount(School("school", "city"), "name.lastname", "password"))
+        or: client = LanisClient(LanisCookie("school id", "session id"))
     client.authenticate()
     print(client.get_substitution_plan())
     client.close()

docs/source/api/exceptions.rst

@@ -5,7 +5,5 @@
 Exceptions reference
 ====================
 
-.. currentmodule:: lanisapi.exceptions
-.. autoclass:: PageNotFoundError
-
-.. autoclass:: NotAuthenticatedError
+.. automodule:: lanisapi.exceptions
+    :members:

docs/source/api/main.rst

@@ -10,17 +10,31 @@ LanisClient
 
 .. autoclass:: lanisapi.LanisClient
 
+Properties
+~~~~~~~~~~~~~~~~~
+
+.. autoproperty:: lanisapi.LanisClient.authentication_cookies
+
 General functions
 ~~~~~~~~~~~~~~~~~
 
 .. currentmodule:: lanisapi.LanisClient
-
 .. autofunction:: authenticate
 
 .. autofunction:: logout
 
 .. autofunction:: close
 
+Authentication types
+~~~~~~~~~~~~~~~~~~~~
+
+.. currentmodule:: lanisapi.functions.authentication_types
+.. autoclass:: School
+
+.. autoclass:: LanisAccount
+
+.. autoclass:: LanisCookie
+
 Get all schools
 ~~~~~~~~~~~~~~~
 
@@ -30,12 +44,6 @@ Functions
 .. currentmodule:: lanisapi.LanisClient
 .. autofunction:: get_schools
 
-Types
-^^^^^
-
-.. currentmodule:: lanisapi.functions.schools
-.. autoclass:: School
-
 Getting the Substitution plan
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
@@ -98,4 +106,21 @@ Types
 ^^^^^
 
 .. currentmodule:: lanisapi.functions.conversations
-.. autoclass:: Conversation
+.. autoclass:: Conversation
+
+Getting all web applets
+~~~~~~~~~~~~~~~~~~~~~~~
+
+Functions
+^^^^^^^^^
+
+.. currentmodule:: lanisapi.LanisClient
+.. autofunction:: get_apps
+
+.. autofunction:: get_available_apps
+
+Types
+^^^^^
+
+.. currentmodule:: lanisapi.functions.apps
+.. autoclass:: App

docs/source/conf.py

@@ -2,31 +2,31 @@
 
 # -- Project information
 
-project = 'LanisAPI'
-copyright = '2023, kurwjan'
-author = 'kurwjan'
+project = "LanisAPI"
+copyright = "2023, kurwjan"
+author = "kurwjan"
 
-release = '0.2.0'
-version = '0.2.0'
+release = "0.3.0"
+version = "0.3.0"
 
 # -- General configuration
 
 extensions = [
-    'sphinx.ext.duration',
-    'sphinx.ext.doctest',
-    'sphinx.ext.autodoc',
-    'sphinx.ext.autosummary',
-    'sphinx.ext.intersphinx',
-    'sphinx.ext.napoleon'
+    "sphinx.ext.duration",
+    "sphinx.ext.doctest",
+    "sphinx.ext.autodoc",
+    "sphinx.ext.autosummary",
+    "sphinx.ext.intersphinx",
+    "sphinx.ext.napoleon"
 ]
 
 intersphinx_mapping = {
-    'python': ('https://docs.python.org/3/', None),
-    'sphinx': ('https://www.sphinx-doc.org/en/master/', None),
+    "python": ("https://docs.python.org/3/", None),
+    "sphinx": ("https://www.sphinx-doc.org/en/master/", None),
 }
-intersphinx_disabled_domains = ['std']
+intersphinx_disabled_domains = ["std"]
 
-templates_path = ['_templates']
+templates_path = ["_templates"]
 
 # -- Options for HTML output
 
@@ -35,4 +35,4 @@
 
 # -- don't show lanisapi.LanisClient at the beginning
 
-add_module_names = False
+add_module_names = False

docs/source/first_steps.rst

@@ -36,20 +36,22 @@ Example code
 
 .. code-block:: python
 
-    from lanisapi import LanisClient, School
+    from lanisapi import LanisClient, LanisAccount, LanisCookie, School
 
     def main():
-        client = LanisClient("schoolid", "name.lastname", "password")
-            or: client = LanisClient(School("Testschule MH", "Testhausen City"), "password")
+        client = LanisClient(LanisAccount("school id", "name.lastname", "password"))
+            or: client = LanisClient(LanisAccount(School("school", "city"), "name.lastname", "password"))
+            or: client = LanisClient(LanisCookie("school id", "session id")) # Use client.authentication_cookies in the previous session
         client.authenticate()
         print(client.get_substitution_plan())
         client.close()
     
     if __name__ == "__main__":
         main()
 
-1. First you initialise the ``LanisClient`` class with the ``schoolid`` you can find it in the url at ``?=i`` in https://start.schulportal.hessen.de/?i=SCHOOLID.
+1. First you initialise the ``LanisClient`` class with the LanisAccount dataclass. You can find the school id in the url at ``?=i`` in https://start.schulportal.hessen.de/?i=SCHOOLID.
 2. Or you initalise it with School(``school``, ``city``).
-3. Then you log in with ``authenticate()``.
-4. Then we print the current substitution plan.
-5. Then we close the client. **You need to do this.**
+3. Or if you already initialised before you can use the previous session and provide ``LanisCookie`` with ``LanisClient.authentication_cookies``.
+4. Then you log in with ``authenticate()``.
+5. Then we print the current substitution plan.
+6. Then we close the client. **You need to do this.**

docs/source/index.rst

@@ -34,18 +34,20 @@ Features
 * Fetch calendar events.
 * Fetch conversations.
 * Fetch all schools that have Lanis.
+* Fetch all web applets with their links.
 
 Overview of future features, problems and other things `here <https://github.com/users/kurwjan/projects/2>`__.
 
 Example
 -------
 .. code-block:: python
 
-    from lanisapi import LanisClient, School
+    from lanisapi import LanisClient, LanisAccount, LanisCookie, School
 
     def main():
-        client = LanisClient("schoolid", "name.lastname", "password")
-            or: client = LanisClient(School("school", "city"), "password")
+        client = LanisClient(LanisAccount("school id", "name.lastname", "password"))
+            or: client = LanisClient(LanisAccount(School("school", "city"), "name.lastname", "password"))
+            or: client = LanisClient(LanisCookie("school id", "session id"))
         client.authenticate()
         print(client.get_substitution_plan())
         client.close()

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "lanisapi"
-version = "0.2.0"
+version = "0.3.0"
 authors = [
     { name = "kurwjan" }
 ]
@@ -40,7 +40,7 @@ dependencies = [
 # Unlike Flake8, Ruff doesn't enable pycodestyle warnings (`W`) or
 # McCabe complexity (`C901`) by default.
 select = ["F","E","W","C901","I","N","D","DTZ","RET","SIM","RSE","Q","ICN","EM","PIE","LOG","ANN","B"]
-ignore = ["DTZ007","DTZ011","ANN101","D416","D404","F405"]
+ignore = ["DTZ007","DTZ011","ANN101","ANN102","D416","D404","F405"]
 
 # Allow fix for all enabled rules (when `--fix`) is provided.
 fixable = ["ALL"]
@@ -73,10 +73,13 @@ exclude = [
 per-file-ignores = {}
 
 # Same as Black.
-line-length = 88
+line-length = 300
 
 # Allow unused variables when underscore-prefixed.
 dummy-variable-rgx = "^(_+|(_+[a-zA-Z0-9_]*[a-zA-Z0-9]+?))$"
 
 # Assume Python 3.11
 target-version = "py311"
+
+[tool.ruff.lint.pycodestyle]
+ignore-overlong-task-comments = true

src/lanisapi/__init__.py

@@ -1,10 +1,21 @@
 """A lib to interact with the Schulportal Hessen. Use LanisClient to interact."""
 
 from .client import LanisClient
+from .functions.apps import App
+from .functions.authentication_types import LanisAccount, LanisCookie, School
 from .functions.calendar import Calendar
 from .functions.conversations import Conversation
-from .functions.schools import School
 from .functions.substitution import SubstitutionPlan
 from .functions.tasks import Task
 
-__all__ = ["LanisClient", "Task", "SubstitutionPlan", "Calendar", "Conversation", "School"]
+__all__ = [
+    "LanisClient",
+    "Task",
+    "SubstitutionPlan",
+    "Calendar",
+    "Conversation",
+    "App",
+    "LanisAccount",
+    "LanisCookie",
+    "School",
+]