Skip to content
Snippets Groups Projects
Commit 86f99ca2 authored by Michel Jouvin's avatar Michel Jouvin
Browse files

README: updated for PyPI-based installation

parent c1cd9a75
No related branches found
No related tags found
No related merge requests found
# OSITAH : Outil de Suivi de Temps et d'Activités basé sur Hito
OSITAH est une application web qui permet le suivi des déclarations de temps dans Hito, leur validation
et leur exportation dans NSIP. L'accès aux différentes fonctionnalités est soumis à l'authentification de
OSITAH est une application web, basée sur le framework [Dash](https://dash.plotly.com), qui permet
le suivi des déclarations de temps dans Hito, leur validation et leur exportation dans NSIP.
L'accès aux différentes fonctionnalités est soumis à l'authentification de
l'utilisateur : les droits dans `ositah` sont dérivés de ceux dans Hito.
OSITAH nécessite un fichier de configuration `ositah.cfg` : par défaut il est recherché dans le
......@@ -9,7 +10,7 @@ répertoire courant et s'il n'existe pas, dans le répertoire où est installé
L'option `--configuration-file` permet de spécifier un autre fichier/localisation, par exemple pour
utiliser une configuration de test.
L'instance de production s'exécute notamment à travers [gunicorn](https://gunicorn.org), un serveur
L'instance de production s'exécute normalement à travers [gunicorn](https://gunicorn.org), un serveur
SWGI écrit en Python et fournit par le module `gunicorn`. Dans ce contexte, le fichier de configuration
doit être placé dans le répertoire défini comme le répertoire courant de l'application (l'option
`--configuration-file` n'est pas utilisable).
......@@ -19,31 +20,23 @@ L'exécution de `ositah` suppose l'accès à la base de donnée Hito.
## Installation
Le déploiement d'OSITAH nécessite le déploiement d'un environnement Python, de préférence distinct
de ce qui est délivré par l'OS car cel pose de gros problèmes avec les prérequis sur les versions
de ce qui est délivré par l'OS car cela pose de gros problèmes avec les prérequis sur les versions
des dépendances. Les environnements recommandés sont [pyenv](https://github.com/pyenv/pyenv),
[poetry](https://python-poetry.org) ou [Anaconda](https://www.anaconda.com/products/individual).
Pour la création d'un environnement virtuel avec Conda, voir la
[documentation spécifique](https://docs.conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html#creating-an-environment-with-commands).
*Note : avec `conda`, il faut utiliser l'option `-c conda-forge` lors de la commande `conda install`.*
Avant d'installer OSITAH, il faut installer le module [hito_tools](https://gitlab.in2p3.fr/hito/hito_tools)
s'il n'est pas disponible dans l'environnement Python utilisé.
Pour installer OSITAH, il faut utiliser les commandes suivantes :
```bash
# Se mettre dans le répertoire où sera téléchargé hito_tools
git clone https://gitlab.in2p3.fr/hito/ositah.git
cd ositah
pip install .
pip install ositah
```
### Dépendances
Pour connaitre la liste des dépendances de l'application OSITAH, voir la propriété `dependencies`
dans le fichier `pyproject.toml`. Elles sont automatiquement installées par la commande `pip`,
sauf [hito_tools](https://gitlab.in2p3.fr/hito/hito_tools) qui doit être installé explicitement.
dans le fichier `pyproject.toml` se trouvant dans les sources de l'application.
Elles sont automatiquement installées par la commande `pip`.
## Configuration
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment