Skip to content
Snippets Groups Projects
Commit 0d2ee952 authored by Adrien Lescourt's avatar Adrien Lescourt
Browse files

Add script installer

parent f37a9a2f
No related branches found
No related tags found
No related merge requests found
Pipeline #39791 failed
.venv .venv
.vscode .vscode
.idea .idea
\ No newline at end of file
# Created by https://www.toptal.com/developers/gitignore/api/python
# Edit at https://www.toptal.com/developers/gitignore?templates=python
### Python ###
# Byte-compiled / optimized / DLL files
__pycache__/
*.py[cod]
*$py.class
# C extensions
*.so
# Distribution / packaging
.Python
build/
develop-eggs/
dist/
downloads/
eggs/
.eggs/
lib/
lib64/
parts/
sdist/
var/
wheels/
share/python-wheels/
*.egg-info/
.installed.cfg
*.egg
MANIFEST
# PyInstaller
# Usually these files are written by a python script from a template
# before PyInstaller builds the exe, so as to inject date/other infos into it.
*.manifest
*.spec
# Installer logs
pip-log.txt
pip-delete-this-directory.txt
# Unit test / coverage reports
htmlcov/
.tox/
.nox/
.coverage
.coverage.*
.cache
nosetests.xml
coverage.xml
*.cover
*.py,cover
.hypothesis/
.pytest_cache/
cover/
# Translations
*.mo
*.pot
# Django stuff:
*.log
local_settings.py
db.sqlite3
db.sqlite3-journal
# Flask stuff:
instance/
.webassets-cache
# Scrapy stuff:
.scrapy
# Sphinx documentation
docs/_build/
# PyBuilder
.pybuilder/
target/
# Jupyter Notebook
.ipynb_checkpoints
# IPython
profile_default/
ipython_config.py
# pyenv
# For a library or package, you might want to ignore these files since the code is
# intended to run in multiple environments; otherwise, check them in:
# .python-version
# pipenv
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
# However, in case of collaboration, if having platform-specific dependencies or dependencies
# having no cross-platform support, pipenv may install dependencies that don't work, or not
# install all needed dependencies.
#Pipfile.lock
# poetry
# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
# This is especially recommended for binary packages to ensure reproducibility, and is more
# commonly ignored for libraries.
# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
#poetry.lock
# pdm
# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
#pdm.lock
# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
# in version control.
# https://pdm.fming.dev/#use-with-ide
.pdm.toml
# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
__pypackages__/
# Celery stuff
celerybeat-schedule
celerybeat.pid
# SageMath parsed files
*.sage.py
# Environments
.env
.venv
env/
venv/
ENV/
env.bak/
venv.bak/
# Spyder project settings
.spyderproject
.spyproject
# Rope project settings
.ropeproject
# mkdocs documentation
/site
# mypy
.mypy_cache/
.dmypy.json
dmypy.json
# Pyre type checker
.pyre/
# pytype static type analyzer
.pytype/
# Cython debug symbols
cython_debug/
# PyCharm
# JetBrains specific template is maintained in a separate JetBrains.gitignore that can
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
# and can be added to the global gitignore or merged into this file. For a more nuclear
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
#.idea/
### Python Patch ###
# Poetry local configuration file - https://python-poetry.org/docs/configuration/#local-configuration
poetry.toml
# ruff
.ruff_cache/
# LSP config files
pyrightconfig.json
# End of https://www.toptal.com/developers/gitignore/api/python
...@@ -3,23 +3,30 @@ ...@@ -3,23 +3,30 @@
Programme python pour gérer les travaux pratiques des étudiants avec la contrainte d'utiliser le gitlab d'HEPIA. Programme python pour gérer les travaux pratiques des étudiants avec la contrainte d'utiliser le gitlab d'HEPIA.
Ce script permet d'automatiser de nombreuses tâches, notamment la création de nombreuses repositories d'un coup, ou encore cloner toutes les repositories contenues dans un groupe, etc. Ce script permet d'automatiser de nombreuses tâches, notamment la création de nombreuses repositories d'un coup, ou encore cloner toutes les repositories contenues dans un groupe, etc.
## Installation et configuration
```
pipx install git+https://gitedu.hesge.ch/isc/projects/practical-work-manager@refactor
```
## Utilisation ## Utilisation
- Créer un groupe et les repositories en une seule commande, avec un repository "image" optionnel et un fichier d'emails (voir [Syntaxe du fichier YAML (REPOS_FILE)](#syntaxe-du-fichier-yaml-repos_file) : - Créer un groupe et les repositories en une seule commande, avec un repository "image" optionnel et un fichier d'emails (voir [Syntaxe du fichier YAML (REPOS_FILE)](#syntaxe-du-fichier-yaml-repos_file) :
```bash ```bash
python pwm -t TOKEN group_repos GROUP_NAME REPOS_FILE [-i IMPORT_URL] pwm -t TOKEN group_repos GROUP_NAME REPOS_FILE [-i IMPORT_URL]
``` ```
- Créer, au sein d'un groupe existant, les repositories en une seule commande, avec un repository "image" optionnel et un fichier d'emails (voir [Syntaxe du fichier YAML (REPOS_FILE)](#syntaxe-du-fichier-yaml-repos_file) : - Créer, au sein d'un groupe existant, les repositories en une seule commande, avec un repository "image" optionnel et un fichier d'emails (voir [Syntaxe du fichier YAML (REPOS_FILE)](#syntaxe-du-fichier-yaml-repos_file) :
```bash ```bash
python pwm -t TOKEN repos GROUP_ID REPOS_FILE [-i IMPORT_URL] pwm -t TOKEN repos GROUP_ID REPOS_FILE [-i IMPORT_URL]
``` ```
- Clone tous les projets des étudiants d'un groupe gitlab (`ID`) dans un répertoire créé à la volée : - Clone tous les projets des étudiants d'un groupe gitlab (`ID`) dans un répertoire créé à la volée :
```bash ```bash
python pwm -t TOKEN clone ID DIRECTORY pwm -t TOKEN clone ID DIRECTORY
``` ```
- Liste les noms des projets dans un groupe : - Liste les noms des projets dans un groupe :
```bash ```bash
python pwm list ID pwm list ID
``` ```
- [Practical Work Manager (pwm)](#practical-work-manager-pwm) - [Practical Work Manager (pwm)](#practical-work-manager-pwm)
......
...@@ -54,10 +54,9 @@ class DataSource: ...@@ -54,10 +54,9 @@ class DataSource:
groups.append(Group(name, repo["users"])) groups.append(Group(name, repo["users"]))
return cls(groups) return cls(groups)
@staticmethod @staticmethod
def _validate_yaml(yaml_file_path) -> bool: def _validate_yaml(yaml_file_path) -> bool:
with open(args.repos_file) as f: with open(yaml_file_path) as f:
repos = yaml.full_load(f) repos = yaml.full_load(f)
for repo in repos: for repo in repos:
if "name" in repo: if "name" in repo:
...@@ -380,14 +379,17 @@ def command_list_users(args): ...@@ -380,14 +379,17 @@ def command_list_users(args):
print(name) print(name)
if __name__ == "__main__": def main():
parser = argparse.ArgumentParser( parser = argparse.ArgumentParser(
description="Practical Work Manager - \ description="Practical Work Manager - \
Manage students PW - Create group, projects or clone repositories" Manage students PW - Create group, projects or clone repositories"
) )
parser.set_defaults(func=lambda _: parser.print_help()) parser.set_defaults(func=lambda _: parser.print_help())
parser.add_argument( parser.add_argument(
"-t", "--token", metavar="TOKEN", help=f"Create a token here: {TOKEN_URL}. -t is not needed if the env var GITEDU_TOKEN is set." "-t",
"--token",
metavar="TOKEN",
help=f"Create a token here: {TOKEN_URL}. -t is not needed if the env var GITEDU_TOKEN is set.",
) )
subparsers = parser.add_subparsers( subparsers = parser.add_subparsers(
metavar="(group_repos | clone | list_project | list_users)" metavar="(group_repos | clone | list_project | list_users)"
...@@ -486,3 +488,7 @@ if __name__ == "__main__": ...@@ -486,3 +488,7 @@ if __name__ == "__main__":
exit(1) exit(1)
args.func(args) args.func(args)
if __name__ == "__main__":
main()
[build-system]
requires = ["setuptools>=78.1"]
build-backend = "setuptools.build_meta"
[project]
name = "pwm"
version = "1.0.0"
authors = [{name="Adrien Lescourt", email="adrien.lescourt@hesge.ch" }]
description = "Helper for gitlab group and repositories creation"
readme = "README.md"
dependencies = ["requests", "pyyaml"]
requires-python = ">=3.9"
[project.scripts]
pwm = "pwm.pwm:main"
[project.urls]
"Homepage" = "https://gitedu.hesge.ch/isc/projects/practical-work-manager"
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment