From 0d2ee952e651accc797acef073cd10d4da6921c1 Mon Sep 17 00:00:00 2001
From: Adrien Lescourt <adrien@lescourt.net>
Date: Wed, 9 Apr 2025 14:07:01 +0200
Subject: [PATCH] Add script installer

---
 .gitignore           | 179 ++++++++++++++++++++++++++++++++++++++++++-
 README.md            |  15 +++-
 pwm.py => pwm/pwm.py |  14 +++-
 pyproject.toml       |  18 +++++
 4 files changed, 217 insertions(+), 9 deletions(-)
 rename pwm.py => pwm/pwm.py (98%)
 create mode 100644 pyproject.toml

diff --git a/.gitignore b/.gitignore
index 18d7bb7..f5da6d4 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,3 +1,180 @@
 .venv
 .vscode
-.idea
\ No newline at end of file
+.idea
+
+# 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
diff --git a/README.md b/README.md
index 9aecd80..9f6e80c 100644
--- a/README.md
+++ b/README.md
@@ -3,23 +3,30 @@
 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.
 
+## Installation et configuration
+
+```
+pipx install git+https://gitedu.hesge.ch/isc/projects/practical-work-manager@refactor
+```
+
+
 ## 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) :
   ```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) :
   ```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 :
   ```bash
-  python pwm -t TOKEN clone ID DIRECTORY
+  pwm -t TOKEN clone ID DIRECTORY
   ```
 - Liste les noms des projets dans un groupe :
   ```bash
-  python pwm list ID
+  pwm list ID
   ```
 
 - [Practical Work Manager (pwm)](#practical-work-manager-pwm)
diff --git a/pwm.py b/pwm/pwm.py
similarity index 98%
rename from pwm.py
rename to pwm/pwm.py
index 07fa11f..bda24c8 100755
--- a/pwm.py
+++ b/pwm/pwm.py
@@ -54,10 +54,9 @@ class DataSource:
             groups.append(Group(name, repo["users"]))
         return cls(groups)
 
-
     @staticmethod
     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)
             for repo in repos:
                 if "name" in repo:
@@ -380,14 +379,17 @@ def command_list_users(args):
             print(name)
 
 
-if __name__ == "__main__":
+def main():
     parser = argparse.ArgumentParser(
         description="Practical Work Manager - \
         Manage students PW - Create group, projects or clone repositories"
     )
     parser.set_defaults(func=lambda _: parser.print_help())
     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(
         metavar="(group_repos | clone | list_project | list_users)"
@@ -486,3 +488,7 @@ if __name__ == "__main__":
             exit(1)
 
     args.func(args)
+
+
+if __name__ == "__main__":
+    main()
diff --git a/pyproject.toml b/pyproject.toml
new file mode 100644
index 0000000..4d0d9f0
--- /dev/null
+++ b/pyproject.toml
@@ -0,0 +1,18 @@
+[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"
-- 
GitLab