DocScoDoc/README.md

#            ScoDoc - Gestion de la scolarité - Version ScoDoc 8

(c) Emmanuel Viennet 1999 - 2021 (voir LICENCE.txt)


Installation: voir instructions à jour sur <https://scodoc.org>

Documentation utilisateur: <https://scodoc.org>

## Branche ScoDoc 8 expérimentale

N'utiliser que pour les développements et tests, dans le cadre de la migration de Zope vers Flask.

La version ScoDoc8 est basée sur Flask (au lieu de Zope) et sur **python 3.7+**.
Elle ne sera pas mise en production, c'est une version de développement pour le passage à Python 3.

De très nombreux changements sont susceptibles d'affecter l'API, mais on s'efforce à ce que rien 
ne soit visible des utilisateurs.

## Work in Progress (WIP)

Développement en cours, certaines pages fonctionnent, d'autres pas.

### État actuel (23 juillet 21)

 - serveur de développement fonctionnel (pas testé en mode "production" sous gunicorn+nginx).

 - logs à revoir

 - pas d'import/export excel.

 - pas de pages gestion utilisateurs.

**En cours:**
 
 - tests, formulaires utilisateurs, logging.
 

## Setup (sur Debian 10 / python3.7)

Pour les dev, le plus simple est de partir d'une install fonctionnelle de ScoDoc7 sous git, et de changer de branche

    git checkout ScoDoc8

Debian 10 est livré avec Python 3.7.

    apt-get install python3-dev
    apt-get install python3-venv
    apt-get install libpq-dev
    apt-get install libcrack2-dev

Création d'un environnement:

    python3 -m venv venv

Puis installation de Flask:
    
    source venv/bin/activate
    pip install flask
    pip install wheel

Installer les dépendances:

    pip install -r requirements-3.7.txt

## Bases de données
ScoDoc8 utilise les bases de département de ScoDoc7, mais une nouvelle base
utilisateurs nommée `SCO8USERS` (au lieu de `SCOUSERS`), qui est manipulée 
via `sqlalchemy`.

### Configuration de la base utilisateurs

Lancer le script `tools/create_database.sh`

Ce script crée une base nommée `SCO8USERS`, appartenant à l'utilisateur (role) postgres `scodoc`.
Cet utilisateur est créé si nécessaire.

### Initialisation de la base utilisateur par Flask

En tant qu'utilisateur `scodoc`:

    flask db init
    flask db migrate -m "users and roles tables"
    flask db upgrade

Puis initialisation de l'appli:

    flask user-db-init

Et saisie du mot de passe `admin`:

    flask user-password admin

On peut ensuite créer des utilisateurs tests avec:

    flask user-create toto Ens RT
    flask user-create tata Ens Info

ou mieux, importer les utilisateurs de ScoDoc7 avec:

    flask user-db-import-scodoc7

(la base `SCOUSERS` de ScoDoc7 n'est pas affectée, ScoDoc8 utilise une base séparée, nommée `SCO8USERS`).

Pour créer un utilisateur "super admin", c'est à dire admin dans tous les départements:

    flask user-create admin1 SuperAdmin @all


## Lancement serveur (développement, sur VM Linux)

En tant qu'utilisateur `scodoc` (pour avoir accès aux bases départements de ScoDoc7):

 1. Lancer memcached:

    memcached

 2. Dans un autre terminal, lancer le serveur:
 
    export FLASK_APP=scodoc.py
    export FLASK_ENV=development
    flask run --host=0.0.0.0

## Tests unitaires

    pytest tests/unit

# TODO

 - page d'erreur ScoValueError
 - redirection pour authentification
 - import/export Excel