[](https://pypi.org/project/iut-pe/)
[](https://roubine.gricad-pages.univ-grenoble-alpes.fr/iut-pe/coverage/)
[](https://gricad-gitlab.univ-grenoble-alpes.fr/roubine/iut-pe/-/jobs/artifacts/main/browse/public/pdf?job=pages)
# IUT poursuites d'études
Automatisation de la création de fiches poursuites d'études avec ScoDoc
## Installation
Installation des dépendances système (ubuntu/debian)
```bash
sudo apt update
sudo apt install texlive-full
```
### Installation avec pip
Création de l'environnement virtuel
```bash
python3 -m venv ~/.virtualenvs/iut-pe
source ~/.virtualenvs/iut-pe/bin/activate
```
Installation
```bash
pip install iut-pe
```
### Installation depuis les sources
Création de l'environnement virtuel
```bash
python3 -m venv ~/.virtualenvs/iut-pe
source ~/.virtualenvs/iut-pe/bin/activate
pip install -U pip
pip install poetry
```
Installation du module (les sources sont ici téléchargées dans un dossier `~/src`)
```
git clone https://gricad-gitlab.univ-grenoble-alpes.fr/roubine/iut-pe.git
cd ~/src/iut-pe
poetry install
```
## Usage
### Fichier de configuration
Le fichier de configuration est au format YAML et par défaut doit dans le chemin courant (là où la commande est exécutée).
L'option `--config` permets d'utiliser un autre chemin lors de l'execution de la commande.
Voici toutes les entrées du fichier:
```yaml
scodoc:
url: https://scodoc.tromblon-univ.fr # L'URL de base du server web ScoDoc
departement: MYDEPT # L'acronyme du département
login: idlee # Votre login
password: SpamEggs # Votre mot de passe
groupe: Parcours # La catégorie des groupes dont les noms seront utilisé pour déterminer le parcours de l'étudiant si plusieurs parcours sont présents
latex:
name: Eric Idle # Vorte nom
city: Tromblon les Jons poussants # La ville où est faite la fiche
address:
- IUT 42 # L'adresse de l'IUT
- Université de Tromblon # sur autant de lignes que vous voulez
- eric.idle@tromblon-univ.fr # avec le mail et le téléphone si vous voulez
paths:
database: ./etudiants.json # le chemin du ficher base de données (défaut: ./etudiants.json)
latex: ./latex # le chemin vers le dossier latex (défaut: ./latex)
pdf: ./pdf # le chemin vers le dossier pdf (défaut: ./pdf)
logo: ./logo.png # le chemin vers le logo (défaut: ./logo.png)
sign: ./sign.png # le chemin vers la signature (défaut: ./sign.png)
```
### Les Commandes
`iut-pe` fournit 3 lignes commandes:
- `iut-pe-ping`: teste si la connection avec ScoDoc fonctionne.
- `iut-pe-fetch`: récupère les informations de ScoDoc et de construire la base de données.
- `iut-pe-build`: crée les fichiers pdf à l'aide de LaTex.
### Exemple de configuration
Toutes les données sont dans le dossier `~/travail/poursuite-etudes` (éviter les espaces).
Pour simplifier **on travaille dans le fichier courant** où on dépose le fichier de configuration.
```bash
cd ~/travail/poursuites-etudes/
cat config.yml
# scodoc:
# url: https://iut1-scodocbut.u-ga.fr
# departement: GCCD
# login: monlogin
# password: monmdp
# groupe: Parcours
# latex:
# name: Emmanuel Roubin
# city: Saint Martin d'hères
# address:
# - IUT 1 de Grenoble
# - Département Génie Civil - Construction Durable
# - Domaine Universitaire
# - 151, rue de la papeterie
# - BP 67
# - 38402 Saint-Martin d’Hères cedex
# - iut1.gccd.de@univ-grenoble-alpes.fr
```
Puis on source l'environnement python.
```bash
source ~/.virtualenvs/iut-pe/bin/activate
```
**Étaper 1:** vérification de la connection. Si vous voyez s'afficher `pong!` c'est que la connection à ScoDoc fonctionne.
```bash
iut-pe-ping
# ping?
# pong!
```
**Étape 2:** création de la base de données.
Pour tous les étudiants des semestres courants
```bash
iut-pe-fetch
```
Uniquement pour le semestre 42 (id à récupérer dans l'URL de ScoDoc)
```bash
iut-pe-fetch --semestre 42
```
Uniquement pour l'étudiant 421 (etudid à récupérer dans l'URL de ScoDoc)
```bash
iut-pe-fetch --etudid 421
```
Cela doit créer un fichier `json` dans le dossier courant. Dans notre cas:
```bash
~/travail/poursuites-etudes/
config.yml
etudiants.json
```
**Étape 3:** construire les fichiers pdf.
Pour cette étape on peut rajouter 2 fichiers `png` dans le dossier courant:
- `~/travail/poursuites-etudes/logo.png`: le logo de l'université
- `~/travail/poursuites-etudes/sign.png`: la signature du DE
On construit les fichiers pdf des étudiants présents dans la base de données avec la commande:
```bash
iut-pe-build
```
Ce qui créé 2 dossiers avec les sources latex (afin de pouvoir les modifier à la main et les recompiler à souhait) et les fichiers pdf. Ici dans le cas où un seul étudiant est dans la base de données on a l'architecture suivante:
```bash
~/travail/poursuites-etudes/
config.yml
etudiants.json
pdf
Nom_Prenom_421.pdf
latex
421.tex
421.tex.log
421.aux
421.log
```
### Notes
- Si vous ne souhaitez pas travailler dans le dossier courant il faudra utiliser l'option `--config` pour localiser le fichier de configuration et renseigner les variables `paths` dans le fichier de configuration.
- L'option `--reset` permet de remettre à 0 la base de données des étudiants afin de ne pas recompiler toutes les fiches à chaque fois.
- Il n'est pas obligatoire d'ajouter un logo ou une signature. Le fiche peut être générée sans.
- Aucun fichier pdf n'est supprimé automatiquement.
## Disclamer
- Cet outil est en phase de développement. Il est uniquement testé sur la configuration du département GCCD de l'IUT1 de Grenoble. La probabilité qu'il ne fonctionne pas pour d'autres configurations est relativement élevée. Merci d'utiliser les [issues](https://gricad-gitlab.univ-grenoble-alpes.fr/roubine/iut-pe/-/issues) en cas de problèmes.
- Pas de support pour d'autres systèmes d'exploitation que Linux avec Debian/Ubuntu.
Raw data
{
"_id": null,
"home_page": "https://gricad-gitlab.univ-grenoble-alpes.fr/roubine/iut-pe",
"name": "iut-pe",
"maintainer": "Emmanuel Roubin",
"docs_url": null,
"requires_python": ">=3.8.1,<4.0.0",
"maintainer_email": "emmanuel.roubin@univ-grenoble-alpes.fr",
"keywords": "BUT,Poursuites d'\u00e9tudes",
"author": "Emmanuel Roubin",
"author_email": "emmanuel.roubin@univ-grenoble-alpes.fr",
"download_url": "https://files.pythonhosted.org/packages/03/72/d815900dc9f2118b08b05e97b1500bac85690cb7f3b73a4e1638d5cc535d/iut_pe-0.1.8.tar.gz",
"platform": null,
"description": "[](https://pypi.org/project/iut-pe/)\n[](https://roubine.gricad-pages.univ-grenoble-alpes.fr/iut-pe/coverage/)\n[](https://gricad-gitlab.univ-grenoble-alpes.fr/roubine/iut-pe/-/jobs/artifacts/main/browse/public/pdf?job=pages)\n\n# IUT poursuites d'\u00e9tudes\nAutomatisation de la cr\u00e9ation de fiches poursuites d'\u00e9tudes avec ScoDoc\n\n## Installation\nInstallation des d\u00e9pendances syst\u00e8me (ubuntu/debian)\n```bash\nsudo apt update\nsudo apt install texlive-full\n```\n\n### Installation avec pip\nCr\u00e9ation de l'environnement virtuel\n```bash\npython3 -m venv ~/.virtualenvs/iut-pe\nsource ~/.virtualenvs/iut-pe/bin/activate\n```\nInstallation\n```bash\npip install iut-pe\n```\n\n### Installation depuis les sources\nCr\u00e9ation de l'environnement virtuel\n```bash\npython3 -m venv ~/.virtualenvs/iut-pe\nsource ~/.virtualenvs/iut-pe/bin/activate\npip install -U pip\npip install poetry\n```\n\nInstallation du module (les sources sont ici t\u00e9l\u00e9charg\u00e9es dans un dossier `~/src`)\n```\ngit clone https://gricad-gitlab.univ-grenoble-alpes.fr/roubine/iut-pe.git\ncd ~/src/iut-pe\npoetry install\n```\n\n## Usage\n### Fichier de configuration\nLe fichier de configuration est au format YAML et par d\u00e9faut doit dans le chemin courant (l\u00e0 o\u00f9 la commande est ex\u00e9cut\u00e9e).\nL'option `--config` permets d'utiliser un autre chemin lors de l'execution de la commande.\n\nVoici toutes les entr\u00e9es du fichier:\n```yaml\nscodoc:\n url: https://scodoc.tromblon-univ.fr # L'URL de base du server web ScoDoc\n departement: MYDEPT # L'acronyme du d\u00e9partement\n login: idlee # Votre login\n password: SpamEggs # Votre mot de passe\n groupe: Parcours # La cat\u00e9gorie des groupes dont les noms seront utilis\u00e9 pour d\u00e9terminer le parcours de l'\u00e9tudiant si plusieurs parcours sont pr\u00e9sents\nlatex:\n name: Eric Idle # Vorte nom\n city: Tromblon les Jons poussants # La ville o\u00f9 est faite la fiche\n address:\n - IUT 42 # L'adresse de l'IUT\n - Universit\u00e9 de Tromblon # sur autant de lignes que vous voulez\n - eric.idle@tromblon-univ.fr # avec le mail et le t\u00e9l\u00e9phone si vous voulez\npaths:\n database: ./etudiants.json # le chemin du ficher base de donn\u00e9es (d\u00e9faut: ./etudiants.json)\n latex: ./latex # le chemin vers le dossier latex (d\u00e9faut: ./latex)\n pdf: ./pdf # le chemin vers le dossier pdf (d\u00e9faut: ./pdf)\n logo: ./logo.png # le chemin vers le logo (d\u00e9faut: ./logo.png)\n sign: ./sign.png # le chemin vers la signature (d\u00e9faut: ./sign.png)\n```\n\n### Les Commandes\n`iut-pe` fournit 3 lignes commandes:\n- `iut-pe-ping`: teste si la connection avec ScoDoc fonctionne.\n- `iut-pe-fetch`: r\u00e9cup\u00e8re les informations de ScoDoc et de construire la base de donn\u00e9es.\n- `iut-pe-build`: cr\u00e9e les fichiers pdf \u00e0 l'aide de LaTex.\n\n### Exemple de configuration\nToutes les donn\u00e9es sont dans le dossier `~/travail/poursuite-etudes` (\u00e9viter les espaces).\nPour simplifier **on travaille dans le fichier courant** o\u00f9 on d\u00e9pose le fichier de configuration.\n\n```bash\ncd ~/travail/poursuites-etudes/\ncat config.yml\n# scodoc:\n# url: https://iut1-scodocbut.u-ga.fr\n# departement: GCCD\n# login: monlogin\n# password: monmdp\n# groupe: Parcours\n# latex:\n# name: Emmanuel Roubin\n# city: Saint Martin d'h\u00e8res\n# address:\n# - IUT 1 de Grenoble\n# - D\u00e9partement G\u00e9nie Civil - Construction Durable\n# - Domaine Universitaire\n# - 151, rue de la papeterie\n# - BP 67\n# - 38402 Saint-Martin d\u2019H\u00e8res cedex\n# - iut1.gccd.de@univ-grenoble-alpes.fr\n```\n\nPuis on source l'environnement python.\n```bash\nsource ~/.virtualenvs/iut-pe/bin/activate\n```\n\n**\u00c9taper 1:** v\u00e9rification de la connection. Si vous voyez s'afficher `pong!` c'est que la connection \u00e0 ScoDoc fonctionne.\n```bash\niut-pe-ping\n# ping?\n# pong! \n```\n\n**\u00c9tape 2:** cr\u00e9ation de la base de donn\u00e9es.\n\nPour tous les \u00e9tudiants des semestres courants\n```bash\niut-pe-fetch\n```\nUniquement pour le semestre 42 (id \u00e0 r\u00e9cup\u00e9rer dans l'URL de ScoDoc)\n```bash\niut-pe-fetch --semestre 42\n```\nUniquement pour l'\u00e9tudiant 421 (etudid \u00e0 r\u00e9cup\u00e9rer dans l'URL de ScoDoc)\n```bash\niut-pe-fetch --etudid 421\n```\nCela doit cr\u00e9er un fichier `json` dans le dossier courant. Dans notre cas:\n```bash\n~/travail/poursuites-etudes/\n config.yml\n etudiants.json\n```\n\n**\u00c9tape 3:** construire les fichiers pdf.\nPour cette \u00e9tape on peut rajouter 2 fichiers `png` dans le dossier courant:\n- `~/travail/poursuites-etudes/logo.png`: le logo de l'universit\u00e9\n- `~/travail/poursuites-etudes/sign.png`: la signature du DE\n\nOn construit les fichiers pdf des \u00e9tudiants pr\u00e9sents dans la base de donn\u00e9es avec la commande:\n```bash\niut-pe-build\n```\nCe qui cr\u00e9\u00e9 2 dossiers avec les sources latex (afin de pouvoir les modifier \u00e0 la main et les recompiler \u00e0 souhait) et les fichiers pdf. Ici dans le cas o\u00f9 un seul \u00e9tudiant est dans la base de donn\u00e9es on a l'architecture suivante:\n```bash\n~/travail/poursuites-etudes/\n config.yml\n etudiants.json\n pdf\n Nom_Prenom_421.pdf\n latex\n 421.tex\n 421.tex.log\n 421.aux\n 421.log\n```\n\n\n### Notes\n- Si vous ne souhaitez pas travailler dans le dossier courant il faudra utiliser l'option `--config` pour localiser le fichier de configuration et renseigner les variables `paths` dans le fichier de configuration.\n- L'option `--reset` permet de remettre \u00e0 0 la base de donn\u00e9es des \u00e9tudiants afin de ne pas recompiler toutes les fiches \u00e0 chaque fois.\n- Il n'est pas obligatoire d'ajouter un logo ou une signature. Le fiche peut \u00eatre g\u00e9n\u00e9r\u00e9e sans.\n- Aucun fichier pdf n'est supprim\u00e9 automatiquement.\n\n## Disclamer\n- Cet outil est en phase de d\u00e9veloppement. Il est uniquement test\u00e9 sur la configuration du d\u00e9partement GCCD de l'IUT1 de Grenoble. La probabilit\u00e9 qu'il ne fonctionne pas pour d'autres configurations est relativement \u00e9lev\u00e9e. Merci d'utiliser les [issues](https://gricad-gitlab.univ-grenoble-alpes.fr/roubine/iut-pe/-/issues) en cas de probl\u00e8mes.\n- Pas de support pour d'autres syst\u00e8mes d'exploitation que Linux avec Debian/Ubuntu.\n",
"bugtrack_url": null,
"license": "LICENSE",
"summary": "Outil de cr\u00e9ation de fiches de poursuites d'\u00e9tudes li\u00e9 \u00e0 ScoDoc",
"version": "0.1.8",
"project_urls": {
"Homepage": "https://gricad-gitlab.univ-grenoble-alpes.fr/roubine/iut-pe",
"Repository": "https://gricad-gitlab.univ-grenoble-alpes.fr/roubine/iut-pe"
},
"split_keywords": [
"but",
"poursuites d'\u00e9tudes"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2288752f69c4bda2c38b6f4c714c90d83b8c2c275b3370749d78401e46c5492b",
"md5": "81385857d59dbd91c02f5b4861bac2a3",
"sha256": "e5f82c511e60e6b32d4de67630feb19126b161082fab6c224c079a1e857300d3"
},
"downloads": -1,
"filename": "iut_pe-0.1.8-py3-none-any.whl",
"has_sig": false,
"md5_digest": "81385857d59dbd91c02f5b4861bac2a3",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8.1,<4.0.0",
"size": 13528,
"upload_time": "2024-01-30T15:33:09",
"upload_time_iso_8601": "2024-01-30T15:33:09.114050Z",
"url": "https://files.pythonhosted.org/packages/22/88/752f69c4bda2c38b6f4c714c90d83b8c2c275b3370749d78401e46c5492b/iut_pe-0.1.8-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0372d815900dc9f2118b08b05e97b1500bac85690cb7f3b73a4e1638d5cc535d",
"md5": "ddb828ce5fd53246955c1a0ce5eb7311",
"sha256": "7ad9e626acbf1945587debd58d5b0b3a90991306518bb77b43cff84a1246b3a5"
},
"downloads": -1,
"filename": "iut_pe-0.1.8.tar.gz",
"has_sig": false,
"md5_digest": "ddb828ce5fd53246955c1a0ce5eb7311",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8.1,<4.0.0",
"size": 13985,
"upload_time": "2024-01-30T15:33:10",
"upload_time_iso_8601": "2024-01-30T15:33:10.339404Z",
"url": "https://files.pythonhosted.org/packages/03/72/d815900dc9f2118b08b05e97b1500bac85690cb7f3b73a4e1638d5cc535d/iut_pe-0.1.8.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-30 15:33:10",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "iut-pe"
}
JSON