ltisuite-26-0 0__tar.gz

ltisuite_26_0-0/LICENSE

@@ -0,0 +1,66 @@
+			 scenari.kelis.fr
+LTI-suite END-USER SOFTWARE LICENSE AGREEMENT
+
+A source code version of LTI-suite that you may use, modify and 
+distribute is available to you free-of-charge from 
+https://download.scenari.software/LTI-suite
+under the MPL 1.1, GPL 2.0, LGPL 2.1 or CeCILL 2.0 license.
+
+The accompanying executable code version of ##app.name## and related 
+documentation (the "product") is made available to you under the terms of this 
+LTI-suite end-user software license agreement (the "agreement"). 
+
+By selecting the "accept" option, or by installing or using ##app.name##, 
+you are consenting to be bound by the agreement. If you do not agree to the 
+terms and conditions of this agreement, do not selecting the "accept" option, 
+and do not install or use any part of ##app.name##.
+
+During the LTI-suite installation process, and at later times, you may 
+be given the option of installing additional components from third-party 
+software providers. The installation and use of those third-party components 
+may be governed by additional license agreements.
+
+1. LICENSE GRANT. scenari.kelis.fr grants you a 
+ non-exclusive license to use the executable code version of the product. 
+ This agreement will also govern any software upgrades provided by 
+ scenari.kelis.fr that replace and/or supplement the original product, 
+ unless such upgrades are accompanied by a separate license, in which case 
+ the terms of that license will govern.
+
+2. TERMINATION. If you breach this agreement your right to use the product will 
+ terminate immediately and without notice, but all provisions of this 
+ agreement except the license grant (paragraph 1) will survive termination 
+ and continue in effect. Upon termination, you must destroy all copies of the 
+ product.
+
+3. PROPRIETARY RIGHTS. Portions of the Product are available in source code 
+ form under the terms of the MPL 1.1, GPL 2.0, LGPL 2.1 or CeCILL 2.0 
+ (collectively,"open source licenses") from https://download.scenari.software/LTI-suite. 
+ Nothing in this agreement will be construed to limit any rights granted 
+ under the open source licenses. Subject to the foregoing, 
+ scenari.kelis.fr, for itself and on behalf of its licensors, hereby 
+ reserves all intellectual property rights in the product, except for the 
+ rights expressly granted in this agreement. You may not remove or alter any 
+ trademark, logo, copyright or other proprietary notice in or on the product.
+ This license does not grant you any right to use the trademarks, service 
+ marks or logos of scenari.kelis.fr or its licensors.
+
+4. DISCLAIMER OF WARRANTY. The product is provided "as is" with all faults. 
+ To the extent permitted by law, scenari.kelis.fr and 
+ scenari.kelis.fr's licensors hereby disclaim all warranties, whether 
+ express or implied, including without limitation warranties that the product 
+ is free of defects, merchantable, fit for a particular purpose and 
+ non-infringing. You bear entire risk as to selecting the product for your 
+ purposes and as to the quality and performance of the product. This 
+ limitation will apply notwithstanding the failure of essential purpose of 
+ any remedy. Some jurisdictions do not allow the exclusion or limitation of 
+ implied warranties, so this disclaimer may not apply to you.
+
+5. LIMITATION OF LIABILITY. Except as required by law, scenari.kelis.fr 
+ will not be liable for any indirect, special, incidental, consequential or 
+ exemplary damages arising out of or in any way relating to this agreement 
+ or the use of or inability to use the product, including without limitation 
+ damages for loss of goodwill, work stoppage, lost profits, loss of data, 
+ and computer failure or malfunction, even if advised of the possibility of 
+ such damages and regardless of the theory (contract, tort or otherwise) 
+ upon which such claim is based.

ltisuite_26_0-0/PKG-INFO

@@ -0,0 +1,120 @@
+Metadata-Version: 2.4
+Name: ltisuite_26_0
+Version: 0
+Summary: Application d'administration en ligne de commande et package de développement Python pour LTI-suite 26.0
+Author-email: Kelis <contact@kelis.fr>
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+Classifier: Intended Audience :: System Administrators
+Classifier: Intended Audience :: Developers
+Classifier: License :: CeCILL-B Free Software License Agreement (CECILL-B)
+Classifier: License :: OSI Approved :: Mozilla Public License 1.1 (MPL 1.1)
+Classifier: License :: OSI Approved :: GNU General Public License v2 (GPLv2)
+Classifier: License :: OSI Approved :: GNU Lesser General Public License v2 (LGPLv2)
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content :: Content Management System
+Classifier: Topic :: Documentation
+Classifier: Topic :: Terminals
+Classifier: Topic :: Terminals :: Terminal Emulators/X Terminals
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+License-File: LICENSE
+Requires-Dist: requests>2
+Project-URL: Documentation, https://doc.scenari.software/${product.name}@${product.version}
+Project-URL: Forum, https://forums.scenari.org/c/solserv/${product.name}
+Project-URL: Homepage, https://scenari.software
+Project-URL: Source, https://source.scenari.software/git/dev-core
+
+# Application d'administration en ligne de commande et package de développement Python pour LTI-suite 26.0
+
+`ltisuite_26_0` fournit :
+  * une application en ligne de commande permettant d'administrer un serveur LTI-suite 26.0 ;
+  * un package de développement Python permettant d'instancier un objet `portal` à utiliser avec l'API [scenaripy_api](https://pypi.org/project/scenaripy-api).
+
+## Utilisation de la commande d'administration
+```
+ltisuite_26_0 [commande] [paramètres] [conf] [-v]
+ - [commande] : Voir la liste des commandes disponibles avec --help.
+ - [paramètres] : Certaines commandes acceptent des paramètres, voir les détails avec --help
+
+ - [conf] : paramètres de la configuration du serveur. Valeurs possibles :
+   -u [login] ou --user [login] : surcharge du nom de l'utilisateur
+   -p [password] ou --password [password] : surcharge du mot de passe
+   -c [./maconf.json] ou --conf [./maconf.json] : surcharge de la conf du portail
+   -l ou --local : chargement de la conf système pour un usage depuis le serveur hébergeant LTI-suite 26.0
+
+ - [-v] : ajouter -v ou --verbose [level] pour rendre l'exécutable plus bavard.
+   Valeurs de level possibles :
+   -v debug : tous les logs de niveau debug
+   -v info : tous les logs de niveau info (une ligne de log par appel réussi)
+   -v warning : tous les logs de niveau warning
+   -v error : tous les logs de niveau erreur (valeur par défaut). Les logs d'erreur sont également publiées sur le flux stderr.
+   -v none : désactive les logs d'erreur sur la sortie standard (les erreurs restent publiées sur le flux stderr).
+```
+
+Utiliser l'aide intégrée (--help) pour consulter la liste des commandes disponibles.
+
+```shell
+# Affichage de l'aide
+ltisuite_26_0 --help
+
+# Enregistrer la configuration dans un fichier pour éditer URLs, user ou mot de passe
+ltisuite_26_0 print_conf > conf.json
+
+# Ping avec verbosité `debug` pour tester sa configuration
+ltisuite_26_0 ping -c conf.json -v debug
+```
+
+## Exemples de scripts pour de gestion des backups
+**Se référer à la [documentation en ligne](https://doc.scenari.software/${product.name}@${product.version}/linux) pour plus de détails sur les backups**
+
+Pour créer une copie des données à backuper
+```shell
+ltisuite_26_0 backup_pre -c conf.json
+# scripter ici la sauvegarde des données
+ltisuite_26_0 backup_post -c conf.json
+```
+
+Pour un backup du répertoire de données sans créer de copie
+```shell
+ltisuite_26_0 backupinplace_pre -c conf.json
+# scripter ici la sauvegarde des données
+ltisuite_26_0 backupinplace_post -c conf.json
+```
+
+Scripter ses backups en Python
+```python
+import ltisuite_26_0.portal
+
+portal = ltisuite_26_0.portal.new_portal(overridden_conf_file="conf.json")
+portal.backup_pre() # ou portal.backupinplace_pre()
+# Scripter ici la sauvegarde des données
+portal.backup_post() # ou portal.backupinplace_pre()
+```
+
+## Utiliser ce package avec scenaripy_api
+
+Vous devez installer `scenaripy_api` au préalable :
+```shell
+pip install scenaripy_api
+```
+
+Quelle que soit la version de votre serveur, il est recomandé d'utiliser **la dernière version** de `scenaripy_api`.
+
+Exemple d'utilisation de l'API :
+```python
+import scenaripy_api
+import ltisuite_26_0.portal
+
+# Création de l'objet portal
+portal = ltisuite_26_0.portal.new_portal(overridden_conf_file="conf.json")
+
+# Appel d'une méthode de l'API
+scenaripy_api.create_or_update_user(portal, account="mon-compte-user", first_name="Prénom", last_name="Nom", roles=["main:reader"], other_props={"password" : "Mon-Password"})
+```
+Pour plus d'information, se référer à la [documentation de l'API](https://doc.scenari.software/SCENARIbuilder/apipython).
+

ltisuite_26_0-0/README.md

@@ -0,0 +1,88 @@
+# Application d'administration en ligne de commande et package de développement Python pour LTI-suite 26.0
+
+`ltisuite_26_0` fournit :
+  * une application en ligne de commande permettant d'administrer un serveur LTI-suite 26.0 ;
+  * un package de développement Python permettant d'instancier un objet `portal` à utiliser avec l'API [scenaripy_api](https://pypi.org/project/scenaripy-api).
+
+## Utilisation de la commande d'administration
+```
+ltisuite_26_0 [commande] [paramètres] [conf] [-v]
+ - [commande] : Voir la liste des commandes disponibles avec --help.
+ - [paramètres] : Certaines commandes acceptent des paramètres, voir les détails avec --help
+
+ - [conf] : paramètres de la configuration du serveur. Valeurs possibles :
+   -u [login] ou --user [login] : surcharge du nom de l'utilisateur
+   -p [password] ou --password [password] : surcharge du mot de passe
+   -c [./maconf.json] ou --conf [./maconf.json] : surcharge de la conf du portail
+   -l ou --local : chargement de la conf système pour un usage depuis le serveur hébergeant LTI-suite 26.0
+
+ - [-v] : ajouter -v ou --verbose [level] pour rendre l'exécutable plus bavard.
+   Valeurs de level possibles :
+   -v debug : tous les logs de niveau debug
+   -v info : tous les logs de niveau info (une ligne de log par appel réussi)
+   -v warning : tous les logs de niveau warning
+   -v error : tous les logs de niveau erreur (valeur par défaut). Les logs d'erreur sont également publiées sur le flux stderr.
+   -v none : désactive les logs d'erreur sur la sortie standard (les erreurs restent publiées sur le flux stderr).
+```
+
+Utiliser l'aide intégrée (--help) pour consulter la liste des commandes disponibles.
+
+```shell
+# Affichage de l'aide
+ltisuite_26_0 --help
+
+# Enregistrer la configuration dans un fichier pour éditer URLs, user ou mot de passe
+ltisuite_26_0 print_conf > conf.json
+
+# Ping avec verbosité `debug` pour tester sa configuration
+ltisuite_26_0 ping -c conf.json -v debug
+```
+
+## Exemples de scripts pour de gestion des backups
+**Se référer à la [documentation en ligne](https://doc.scenari.software/${product.name}@${product.version}/linux) pour plus de détails sur les backups**
+
+Pour créer une copie des données à backuper
+```shell
+ltisuite_26_0 backup_pre -c conf.json
+# scripter ici la sauvegarde des données
+ltisuite_26_0 backup_post -c conf.json
+```
+
+Pour un backup du répertoire de données sans créer de copie
+```shell
+ltisuite_26_0 backupinplace_pre -c conf.json
+# scripter ici la sauvegarde des données
+ltisuite_26_0 backupinplace_post -c conf.json
+```
+
+Scripter ses backups en Python
+```python
+import ltisuite_26_0.portal
+
+portal = ltisuite_26_0.portal.new_portal(overridden_conf_file="conf.json")
+portal.backup_pre() # ou portal.backupinplace_pre()
+# Scripter ici la sauvegarde des données
+portal.backup_post() # ou portal.backupinplace_pre()
+```
+
+## Utiliser ce package avec scenaripy_api
+
+Vous devez installer `scenaripy_api` au préalable :
+```shell
+pip install scenaripy_api
+```
+
+Quelle que soit la version de votre serveur, il est recomandé d'utiliser **la dernière version** de `scenaripy_api`.
+
+Exemple d'utilisation de l'API :
+```python
+import scenaripy_api
+import ltisuite_26_0.portal
+
+# Création de l'objet portal
+portal = ltisuite_26_0.portal.new_portal(overridden_conf_file="conf.json")
+
+# Appel d'une méthode de l'API
+scenaripy_api.create_or_update_user(portal, account="mon-compte-user", first_name="Prénom", last_name="Nom", roles=["main:reader"], other_props={"password" : "Mon-Password"})
+```
+Pour plus d'information, se référer à la [documentation de l'API](https://doc.scenari.software/SCENARIbuilder/apipython).

ltisuite_26_0-0/pyproject.toml

@@ -0,0 +1,39 @@
+[build-system]
+requires = ["flit_core >=3.9,<4"]
+build-backend = "flit_core.buildapi"
+[project]
+name = "ltisuite_26_0"
+version = "0"
+description =	"Application d'administration en ligne de commande et package de développement Python pour LTI-suite 26.0"
+license = {file = "LICENSE"}
+authors = [{name = "Kelis", email = "contact@kelis.fr"}]
+readme="README.md"
+requires-python = ">=3.10"
+dependencies = ["requests>2"]
+classifiers = [
+		"Intended Audience :: System Administrators",
+		"Intended Audience :: Developers",
+		"License :: CeCILL-B Free Software License Agreement (CECILL-B)",
+		"License :: OSI Approved :: Mozilla Public License 1.1 (MPL 1.1)",
+		"License :: OSI Approved :: GNU General Public License v2 (GPLv2)",
+		"License :: OSI Approved :: GNU Lesser General Public License v2 (LGPLv2)",
+		"Operating System :: OS Independent",
+		"Programming Language :: Python :: 3",
+		"Programming Language :: Python :: 3.10",
+		"Programming Language :: Python :: 3.11",
+		"Programming Language :: Python :: 3.12",
+		"Programming Language :: Python :: 3.13",
+		"Topic :: Internet :: WWW/HTTP :: Dynamic Content :: Content Management System",
+		"Topic :: Documentation",
+		"Topic :: Terminals",
+		"Topic :: Terminals :: Terminal Emulators/X Terminals",
+    "Topic :: Software Development :: Libraries :: Python Modules"
+]
+[project.urls]
+Homepage= "https://scenari.software"
+Documentation= "https://doc.scenari.software/${product.name}@${product.version}"
+Source= "https://source.scenari.software/git/dev-core"
+Forum= "https://forums.scenari.org/c/solserv/${product.name}"
+
+[project.scripts]
+ltisuite_26_0 = "ltisuite_26_0.portal:__main"

ltisuite_26_0-0/src/ltisuite_26_0/__init__.py

@@ -0,0 +1,2 @@
+
+__all__ = ["portal", "portlets", "api", "appsaas", "common", "core", "distrib", "orient", "store", "urltree", "wsp"]

ltisuite_26_0-0/src/ltisuite_26_0/api/__init__.py

@@ -0,0 +1,2 @@
+
+__all__ = ["item", "search"]

ltisuite_26_0-0/src/ltisuite_26_0/api/item.py

@@ -0,0 +1,117 @@
+"""Ce module contient des constantes (sous forme d'Enum) et structures de données (préfixe pour items spécifiques, statuts de dérivation ou de calque de travail, champs de description d'un item et structure de données spécifique aux exports pour envoi des données)."""
+
+from typing import TypedDict, NotRequired
+
+from ..common.utils import StrEnum
+
+class EItemPrefix(StrEnum):
+    """Liste de valeurs de préfixe d'un chemin vers un item (src_uri). Les fonctions adressées par ces préfixes sont disponibles en DB uniquement."""
+    AIR_PREFIX = "/~air/"  # Préfixe d'un air item
+    """Test attribute doc"""
+    EXT_PREFIX = "/~ext/"  # Préfixe d'un item externe
+    TRANSIENT_PREFIX = "/~transient/"
+    ANNOT_PREFIX = "/~annot/"
+    HISTORY_PREFIX = "/~history/"  # Préfixe d'un item en historique
+    TRASH_PREFIX = "/~history~trash/"  # Préfixe d'un item en corbeille
+
+
+class EDrvState(StrEnum):
+    """État d'un item dans un atelier dérivé."""
+    erased = "erased"  # Item supprimé
+    notOverriden = "notOverriden"  # Item non surchargé, jamais marqué "achevé"
+    notOverridenDone = "notOverridenDone"  # Item non surchargé, marqué achevé
+    createdDone = "createdDone"  # Item spécifique à l'atelier dérivé, marqué achevé
+    overridenDone = "overridenDone"  # Item surchargé dans l'atelier dérivé, marqué achevé
+    createdNew = "createdNew"  # Item spécifique à l'atelier dérivé, mais non marqué achevé
+    overridenNew = "overridenNew"  # Item surchargé dans l'atelier dérivé, mais non marqué achevé
+    notOverridenDirty = "notOverridenDirty"  # Item non surchargé, marqué achevé puis déphasé
+    createdDirty = "createdDirty"  # Item spécifique à l'atelier dérivé, marqué achevé puis déphasé
+    overridenDirty = "overridenDirty"  # Item surchargé dans l'atelier dérivé, marqué achevé puis déphasé
+    createdNotComputed = "createdNotComputed"  # Item spécifique à l'atelier dérivé, état inconnu
+    notComputed = "notComputed"  # État de l'item inconnu
+
+
+class EDrfState(StrEnum):
+    """État d'un item dans un atelier calque de travail."""
+    erased = "erased"  # Item supprimé
+    notOverriden = "notOverriden"  # Item inchangé
+    overriden = "overriden"  # Item modifié
+    created = "created"  # Item créé dans l'atelier calque
+    createdDeleted = "createdDeleted"  # Item créé puis supprimé
+    notComputed = "notComputed"  # État de l'item inconnu
+
+
+class ESrcField(StrEnum):
+    """Liste des champs de données possiblement associés à un item."""
+    # NB : seuls les champs commentés avec le caractère # ont valeur d'API.
+    srcUri = "srcUri"  # Chemin de l'item.
+    srcId = "srcId"  # ID d'un item (attention, un ID n'est pas stable). [NON API]
+    itSubItem = "itSubItem"  # XML ID d'un sub-item. Supporté par certains modèles uniquement. [NON API]
+
+    item = "item"  # demande à a fois : itSt, itSgn, itModel [NON API]
+    sdOdb = "sdOdb"  # demande à la fois : srcUri, srcSt, srcDt, srcRi, srcRoles, srcId, srcStamp, srcUser, itSt, itSgn et itModel [NON API]
+
+    srcNm = "srcNm"  # Retourne le nom de la ressource. [NON API]
+    srcSt = "srcSt"  # Retourne le status de la ressource (de type int, 1 pour un fichier, 2 pour un dossier et -1 si la ressource n'existe pas). [NON API]
+    srcDt = "srcDt"  # `Timestamp` de dernière modification.
+    srcStamp = "srcStamp"  # Retourne une chaîne d'empreinte (hash) du contenu. [NON API]
+    srcTreeDt = "srcTreeDt"  # Retourne la date de dernière modification de la ressource et son arborescence fille. [NON API]
+    srcSi = "srcSi"  # Retourne la taille du contenu. [NON API]
+    srcTy = "srcTy"  # Retourne le content-type associé à ce contenu. [NON API]
+    srcRi = "srcRi"  # Retourne les droits d'accès sous la forme d'un int. Ce champ est un indice utilisé par l'IHM Scenari. Ne pas utiliser en dehors. [NON API]
+    srcRoles = "srcRoles"  # Retourne les rôles résolus pour cette ressource. [NON API]
+    srcUser = "srcUser"  # Utilisateur ayant effectué la dernière modification.
+    srcLiveUri = "srcLiveUri"  # URL "live" d'un nœud placé en historique ou supprimé. [NON API]
+    srcTrashed = "srcTrashed"  # srcTrashed pour savoir si ce nœud a été explicitement placé en corbeille (contrairement à `srcSt` qui renvoie -1 si le nœud OU au moins un nœud de son contexte ascendant a été supprimé). [NON API]
+    metaComment = "metaComment"  # Pour récupérer un commentaire associé à cet item (pour une entrée d'historique par exemple). [NON API]
+    metaFlag = "metaFlag"  # Flag (retourné sous forme de int) associé à cet item (pour une entrée d'historique par exemple). [NON API]
+
+    cidEndPoints = "cidEndPoints"  # Liste des dernières destination d'envoi via CID de cet item. [NON API]
+
+    drvState = "drvState"  # État de dérivation.
+    drvAxisDefCo = "drvAxisDefCo"  # Axis auquel appartient le contenu par défaut de cette dérivation.
+
+    drfState = "drfState"  # État de surcharge dans un atelier calque de travail.
+
+    itTi = "itTi"  # Titre d'un item.
+    itSt = "itSt"  # Statut d'un item (-1 : n'existe pas, -2 : item en conflit, -99 : statut inconnu, 1 : statut ok, 2 : contient des warnings, 3, item en erreur, 11 : état asynchrone d'un item en cours de validation). [NON API]
+    itSgn = "itSgn"  # Signature de l'item. [NON API]
+    itModel = "itModel"  # Code du modèle associé à l'item
+    itFullUriInOwnerWsp = "itFullUriInOwnerWsp"  # fullUri d'un item dans son atelier propriétaire. Utilisé par l'atelier qui inclut un item externe. [NON API]
+    itSubItems = "itSubItems"  # Liste des sub-items contenu dans cet item. [NON API]
+    itSubItemAnc = "itSubItemAnc"  # Permet d'obtenir la liste des propriétés des subItems ancêtres du subItem pointé. [NON API]
+
+    lcSt = "lcSt"  # État du cycle de vie.
+    lcDt = "lcDt"  # Date du dernier changement de cycle de vie.
+    lcBy = "lcBy"  # Utilisateur ayant déclenché le dernier changement de cycle de vie.
+    lcTrP = "lcTrP"  # True si une transition est en cours. [NON API]
+
+    rspUsrs = "rspUsrs"  # Pour obtenir une liste des users et de leurs responsabilités associés à un item donné. [NON API]
+    rspSt = "rspSt"  # Statut des responsabilité de l'item (-1 : inconnu, 1 : ok, 3 : en erreur). [NON API]
+
+    tkPending = "tkPending"  # La tâche est en cours. [NON API]
+    tkPendingCount = "tkPendingCount"  # Nombre de tâches en cours associées à une source. [NON API]
+    tkForthcoming = "tkForthcoming"  # La tâche est planifiée. [NON API]
+    tkForthcomingCount = "tkForthcomingCount"  # Nombre de tâches planifiées associées à une source. [NON API]
+
+    tkDeadline = "tkDeadline"  # Deadline de la tâche. [NON API]
+    tkCompletedDt = "tkCompletedDt"  # Date du passage à l'état complété de la tâche. [NON API]
+    tkCompletedBy = "tkCompletedBy"  # User qui a passé la tâche à l'état complété. [NON API]
+
+    actStage = "actStage"  # État de l'action (completed, pending, forthcoming). [NON API]
+    actTi = "actTi"  # Titre de l'action. [NON API]
+    actCts = "actCts"  # Liste des source liées à cette action. [NON API]
+
+    wspOwner = "wspOwner"  # Code de l'atelier propriétaire de la source. [NON API]
+
+
+class JSendProps(TypedDict):
+    """
+    Structure de données permettant de spécifier un envoi de contenu HTTP via le service remoteContent de Scenari.
+    """
+    url: str
+    method: NotRequired[str]  # Valeur par défaut : "GET"
+    timeout: NotRequired[int]  # Pas de `timeout` par défaut
+    headerProps: NotRequired[dict[str, str | list[str]]]
+    addQSParams: NotRequired[dict[str, str]]  # Ajout de querystring en plus de ceux possiblement présents dans l'URL
+    setQSParams: NotRequired[dict[str, str]]  # Remplacement de querystring déjà présent dans l'URL