跳转到主要内容

与ScoDoc相关的学习跟进工具

项目描述

Badge pypi version Coverage Badge exemples

IUT学习跟进

使用ScoDoc自动化创建学习跟进文档

安装

系统依赖项安装(ubuntu/debian)

sudo apt update
sudo apt install texlive-full

使用pip安装

创建虚拟环境

python3 -m venv ~/.virtualenvs/iut-pe
source  ~/.virtualenvs/iut-pe/bin/activate

安装

pip install iut-pe

从源码安装

创建虚拟环境

python3 -m venv ~/.virtualenvs/iut-pe
source  ~/.virtualenvs/iut-pe/bin/activate
pip install -U pip
pip install poetry

安装模块(源码在此目录下载到 ~/src 文件夹中)

git clone https://gricad-gitlab.univ-grenoble-alpes.fr/roubine/iut-pe.git
cd ~/src/iut-pe
poetry install

使用方法

配置文件

配置文件格式为YAML,默认情况下应在当前路径(执行命令的位置)中。使用 --config 选项可以在执行命令时使用其他路径。

以下是配置文件的所有条目

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)

命令

iut-pe 提供了3条命令

  • iut-pe-ping: 测试与ScoDoc的连接是否正常。
  • iut-pe-fetch: 获取ScoDoc信息并构建数据库。
  • iut-pe-build: 使用LaTex创建PDF文件。

配置示例

所有数据都在 ~/travail/poursuite-etudes 文件夹中(避免使用空格)。为了简化,我们将在当前文件中工作,其中放置配置文件。

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

然后,source Python环境。

source  ~/.virtualenvs/iut-pe/bin/activate

步骤1: 验证连接。如果您看到显示 pong!,则表示与ScoDoc的连接正常。

iut-pe-ping
# ping?
# pong! 

步骤 2: 创建数据库。

对于所有当前学期的学生

iut-pe-fetch

仅针对第 42 学期(在 ScoDoc 的 URL 中获取 id)

iut-pe-fetch --semestre 42

仅针对学生 421(在 ScoDoc 的 URL 中获取 etudid)

iut-pe-fetch --etudid 421

这将在当前目录下创建一个 json 文件。在我们的例子中

~/travail/poursuites-etudes/
    config.yml
    etudiants.json

步骤 3: 构建PDF文件。对于这个步骤,我们可以在当前目录中添加2个 png 文件

  • ~/travail/poursuites-etudes/logo.png:大学的标志
  • ~/travail/poursuites-etudes/sign.png:文凭的签名

我们使用以下命令构建数据库中学生的PDF文件

iut-pe-build

这会创建2个包含源LaTeX文件(以便可以手动修改和重新编译)和PDF文件的目录。在这里,如果数据库中只有一个学生,架构如下

~/travail/poursuites-etudes/
    config.yml
    etudiants.json
    pdf
        Nom_Prenom_421.pdf
    latex
        421.tex
        421.tex.log
        421.aux
        421.log

注意事项

  • 如果您不希望在工作目录中工作,您必须使用 --config 选项来定位配置文件,并在配置文件中填写 paths 变量。
  • --reset 选项允许将学生数据库重置为零,以便每次不需要重新编译所有文件。
  • 添加标志或签名不是必需的。文件可以不添加这些内容生成。
  • 不会自动删除任何PDF文件。

免责声明

  • 此工具处于开发阶段。它仅在格勒诺布尔IUT1的GCCD部门配置上进行测试。它可能无法适应其他配置,概率相对较高。如果出现问题,请使用 issues
  • 不支持除Linux Debian/Ubuntu以外的操作系统。

项目详情


下载文件

下载适合您平台的文件。如果您不确定选择哪个,请了解更多关于 安装包 的信息。

源分布

iut_pe-0.1.8.tar.gz (14.0 kB 查看哈希值)

上传时间

构建分布

iut_pe-0.1.8-py3-none-any.whl (13.5 kB 查看哈希值)

上传时间 Python 3

由以下组织支持

AWS AWS 云计算和安全赞助商 Datadog Datadog 监控 Fastly Fastly CDN Google Google 下载分析 Microsoft Microsoft PSF 赞助商 Pingdom Pingdom 监控 Sentry Sentry 错误日志 StatusPage StatusPage 状态页面