odysseeapi 0.0.1__tar.gz → 0.2.0__tar.gz

{odysseeapi-0.0.1 → odysseeapi-0.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: odysseeapi
-Version: 0.0.1
+Version: 0.2.0
 Summary: Unofficial Python API for Odyssee
 Author-email: Géry Casiez <gery.casiez@univ-lille.fr>
 Project-URL: Repository, https://github.com/casiez/OdysseeAPI
@@ -8,18 +8,22 @@ Classifier: Programming Language :: Python :: 3
 Classifier: License :: OSI Approved :: BSD License
 Description-Content-Type: text/markdown
 
+[![PyPI Version](https://img.shields.io/pypi/v/odysseeapi)](https://pypi.org/project/odysseeapi/)
+[![Downloads](https://static.pepy.tech/badge/odysseeapi)](https://pepy.tech/project/odysseeapi)
+
 # Odyssee API
 
 Provides an unofficial API for the [Odyssee platform](https://odyssee.enseignementsup-recherche.gouv.fr/), allowing users to access and interact with their data programmatically.
 
 ## Features
 
+- download applications of candidates
 - get information about candidates
 - get information about committee members
 - get information about institutions
 - get keywords
 - assign applications to committee members
-- get reports from committee members
+- download reports from committee members
 - provide decision on each candidate after the first round of evaluation
 
 ## Installation
@@ -52,6 +56,14 @@ from odysseeapi.Odyssee import Odyssee
 
 numposte = "123456"
 token = """eyJhbGciOiJSUzI1N... (token value) ..."""
+
+# Initialize the API client with the numposte, token and use_cache set to True
+# setting use_cache to False forces the API client to fetch fresh data from the server for each request, while setting it to True allows the client to use cached data if available
+odyssee = Odyssee(numposte, token, True)
+
+# Download the applications of the candidates in the specified directory
+odyssee.download_applications('dossiers_candidats')
+
 candidates = odyssee.get_candidates()
 print(candidates)
 
@@ -70,7 +82,7 @@ print(candidates_with_details)
 # odyssee.assign_jury_members_to_candidate("f1e2d3c4-b5a6-4789-9876-543210fedcba", "98765432-10fe-dcba-9876-543210fedcba", "abcd1234-5678-90ef-ghij-klmnopqrstuv")
 
 # Download the reports of the committee members for the candidates in the specified directory
-odyssee.downloadReports("rapportsOdyssee")
+odyssee.downloadReports("rapports_odyssee")
 
 # A l'issue de la première réunion du jury, enregistrer l'avis pour chaque candidat et les résultats du vote
 # odyssee.opinion_for_interview("f1e2d3c4-b5a6-4789-9876-543210fedcba", "A", "Motif audition", 16, 16, 0, 0, 16, 0)

{odysseeapi-0.0.1 → odysseeapi-0.2.0}/Readme.md

@@ -1,15 +1,19 @@
+[![PyPI Version](https://img.shields.io/pypi/v/odysseeapi)](https://pypi.org/project/odysseeapi/)
+[![Downloads](https://static.pepy.tech/badge/odysseeapi)](https://pepy.tech/project/odysseeapi)
+
 # Odyssee API
 
 Provides an unofficial API for the [Odyssee platform](https://odyssee.enseignementsup-recherche.gouv.fr/), allowing users to access and interact with their data programmatically.
 
 ## Features
 
+- download applications of candidates
 - get information about candidates
 - get information about committee members
 - get information about institutions
 - get keywords
 - assign applications to committee members
-- get reports from committee members
+- download reports from committee members
 - provide decision on each candidate after the first round of evaluation
 
 ## Installation
@@ -42,6 +46,14 @@ from odysseeapi.Odyssee import Odyssee
 
 numposte = "123456"
 token = """eyJhbGciOiJSUzI1N... (token value) ..."""
+
+# Initialize the API client with the numposte, token and use_cache set to True
+# setting use_cache to False forces the API client to fetch fresh data from the server for each request, while setting it to True allows the client to use cached data if available
+odyssee = Odyssee(numposte, token, True)
+
+# Download the applications of the candidates in the specified directory
+odyssee.download_applications('dossiers_candidats')
+
 candidates = odyssee.get_candidates()
 print(candidates)
 
@@ -60,7 +72,7 @@ print(candidates_with_details)
 # odyssee.assign_jury_members_to_candidate("f1e2d3c4-b5a6-4789-9876-543210fedcba", "98765432-10fe-dcba-9876-543210fedcba", "abcd1234-5678-90ef-ghij-klmnopqrstuv")
 
 # Download the reports of the committee members for the candidates in the specified directory
-odyssee.downloadReports("rapportsOdyssee")
+odyssee.downloadReports("rapports_odyssee")
 
 # A l'issue de la première réunion du jury, enregistrer l'avis pour chaque candidat et les résultats du vote
 # odyssee.opinion_for_interview("f1e2d3c4-b5a6-4789-9876-543210fedcba", "A", "Motif audition", 16, 16, 0, 0, 16, 0)

{odysseeapi-0.0.1 → odysseeapi-0.2.0}/odysseeapi/Odyssee.py

@@ -37,10 +37,11 @@ import tqdm
 import os
 
 class Odyssee(object):
-    def __init__(self, numposte, bearer_token):
+    def __init__(self, numposte, bearer_token, use_cache=True):
         """Initialize the Odyssee class.
         numposte: the numposte to use for the API calls
-        bearer_token: the bearer token to use for the API calls"""
+        bearer_token: the bearer token to use for the API calls
+        use_cache: whether to use caching for API responses (default: True)"""
 
         self.numposte = numposte
         self.base_url = "https://odyssee.enseignementsup-recherche.gouv.fr/gateway/"
@@ -52,6 +53,26 @@ class Odyssee(object):
         self.etablissements = None
         self.keywords = None
         self.reportsPath = "rapportsOdyssee"
+        self.use_cache = use_cache
+        self.__loadCache()
+
+    def __loadCache(self):
+        if os.path.exists("cache.json"):
+            with open("cache.json", "r") as f:
+                self.cache = json.load(f)
+        else:
+            self.cache = {
+                "candidatures": None,
+                "rapporteurs": None,
+                "etablissements": None,
+                "keywords": None,
+                "detailCandidatures": None
+            }
+
+    def __saveToCache(self, key, value):
+        self.cache[key] = value
+        with open("cache.json", "w") as f:
+            json.dump(self.cache, f)
 
     def get_candidates(self):
         """
@@ -82,12 +103,17 @@ class Odyssee(object):
             } 
         """
 
+        if self.use_cache and self.cache.get("candidatures", None) is not None:
+            self.candidatures = self.cache["candidatures"]
+            return self.candidatures
+
         candidatures = self.s.get(f"{self.base_url}recrutements/offre-poste/candidature/candidatures/examen/{self.numposte}", params={"page": "0", "limite": "200", "filtres": "()"}, headers=self.headers, cookies=self.cookies)
         if candidatures.status_code != 200:
             msg = f"Failed to get candidatures: {candidatures.status_code} - {candidatures.text}"
             raise Exception(msg)
         json_data = json.loads(candidatures.content)
         self.candidatures = json_data["content"]
+        self.__saveToCache("candidatures", self.candidatures)
         return self.candidatures
     
     def get_committee_members(self):
@@ -107,12 +133,18 @@ class Odyssee(object):
                 "numeroRapporteur": 
             }
         """
+
+        if self.use_cache and self.cache.get("rapporteurs", None) is not None:
+            self.rapporteurs = self.cache["rapporteurs"]
+            return self.rapporteurs
+
         rapporteurs = self.s.get(f"{self.base_url}recrutements/offre-jury/chercher-rapporteurs/{self.numposte}", params={"page": "0", "limite": "50"}, headers=self.headers, cookies=self.cookies)
         if rapporteurs.status_code != 200:
             msg = f"Failed to get rapporteurs: {rapporteurs.status_code} - {rapporteurs.text}"
             raise Exception(msg)
         json_data = json.loads(rapporteurs.content)
         self.rapporteurs = json_data["content"]
+        self.__saveToCache("rapporteurs", self.rapporteurs)
         return self.rapporteurs
     
     def get_institutions(self):
@@ -161,11 +193,17 @@ class Odyssee(object):
                     "description": 
                 }
         """
+
+        if self.use_cache and self.cache.get("etablissements", None) is not None:
+            self.etablissements = self.cache["etablissements"]
+            return self.etablissements
+        
         etablissements = self.s.get(f"{self.base_url}referentiels/etablissements", headers=self.headers, cookies=self.cookies)
         if etablissements.status_code != 200:
             msg = f"Failed to get etablissements: {etablissements.status_code} - {etablissements.text}"
             raise Exception(msg)
         self.etablissements = json.loads(etablissements.content)
+        self.__saveToCache("etablissements", self.etablissements)
         return self.etablissements
     
     def get_keywords(self):
@@ -178,13 +216,47 @@ class Odyssee(object):
                 "supprimable": 
             }
         """
+
+        if self.use_cache and self.cache.get("keywords", None) is not None:
+            self.keywords = self.cache["keywords"]
+            return self.keywords
+
         keywords = self.s.get(f"{self.base_url}referentiels/mots-cles", headers=self.headers, cookies=self.cookies)
         if keywords.status_code != 200:
             msg = f"Failed to get mots clés: {keywords.status_code} - {keywords.text}"
             raise Exception(msg)
         self.keywords = json.loads(keywords.content)
+        self.__saveToCache("keywords", self.keywords)
         return self.keywords
 
+    def download_applications(self, path):
+        """Download applications for a given numposte and save them in the specified path."""
+        self.__createDir(path)
+
+        if self.candidatures is None:
+            self.get_candidates()
+
+        for c in tqdm.tqdm(self.candidatures, desc="Téléchargement des dossiers des candidatures"):
+            id_candidat = c["candidat"]["idKeycloakActuel"]
+
+            response = self.s.get(f"{self.base_url}recrutements/offre-poste/candidature/telecharger-dossier-candidature/{self.numposte}/{id_candidat}", headers=self.headers, cookies=self.cookies)
+
+            if response.status_code == 200:
+                chemin = response.content
+                fileName = f"{path}/{c['candidat']['nomUsage'].upper()}_{c['candidat']['prenom'].capitalize()}_{id_candidat}.zip"
+
+                response2 = self.s.get(f"{self.base_url}s3/fichier", params={"chemin": chemin}, headers=self.headers, cookies=self.cookies)
+
+                if response2.status_code == 200:
+                    with open(fileName, "wb") as f:
+                        f.write(response2.content)
+                else:
+                    msg = f"Failed to download application for candidate {id_candidat}: {response2.status_code} - {response2.text}"
+                    raise Exception(msg)
+            else:
+                msg = f"Failed to download application information for candidate {id_candidat}: {response.status_code} - {response.text}"
+                raise Exception(msg)
+
     def __detailCandidature(self, id_candidat):
         candidature = self.s.get(f"{self.base_url}recrutements/offre-poste/candidature/detail-candidature/{self.numposte}/{id_candidat}", headers=self.headers, cookies=self.cookies)
         if candidature.status_code != 200:
@@ -252,6 +324,11 @@ class Odyssee(object):
             ]
         },
         """
+
+        if self.use_cache and self.cache.get("detailCandidatures", None) is not None:
+            self.detailCandidatures = self.cache["detailCandidatures"]
+            return self.detailCandidatures
+
         if self.candidatures is None:
             self.get_candidates()
 
@@ -259,6 +336,7 @@ class Odyssee(object):
         for c in tqdm.tqdm(self.candidatures, desc="Récupération des détails des candidatures"):
             id_candidat = c["candidat"]["idKeycloakActuel"]
             self.detailCandidatures.append(self.__detailCandidature(id_candidat))
+        self.__saveToCache("detailCandidatures", self.detailCandidatures)
         return self.detailCandidatures
     
     def assign_jury_members_to_candidate(self, id_candidat, id_rapporteur1, id_rapporteur2):

{odysseeapi-0.0.1 → odysseeapi-0.2.0}/odysseeapi.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: odysseeapi
-Version: 0.0.1
+Version: 0.2.0
 Summary: Unofficial Python API for Odyssee
 Author-email: Géry Casiez <gery.casiez@univ-lille.fr>
 Project-URL: Repository, https://github.com/casiez/OdysseeAPI
@@ -8,18 +8,22 @@ Classifier: Programming Language :: Python :: 3
 Classifier: License :: OSI Approved :: BSD License
 Description-Content-Type: text/markdown
 
+[![PyPI Version](https://img.shields.io/pypi/v/odysseeapi)](https://pypi.org/project/odysseeapi/)
+[![Downloads](https://static.pepy.tech/badge/odysseeapi)](https://pepy.tech/project/odysseeapi)
+
 # Odyssee API
 
 Provides an unofficial API for the [Odyssee platform](https://odyssee.enseignementsup-recherche.gouv.fr/), allowing users to access and interact with their data programmatically.
 
 ## Features
 
+- download applications of candidates
 - get information about candidates
 - get information about committee members
 - get information about institutions
 - get keywords
 - assign applications to committee members
-- get reports from committee members
+- download reports from committee members
 - provide decision on each candidate after the first round of evaluation
 
 ## Installation
@@ -52,6 +56,14 @@ from odysseeapi.Odyssee import Odyssee
 
 numposte = "123456"
 token = """eyJhbGciOiJSUzI1N... (token value) ..."""
+
+# Initialize the API client with the numposte, token and use_cache set to True
+# setting use_cache to False forces the API client to fetch fresh data from the server for each request, while setting it to True allows the client to use cached data if available
+odyssee = Odyssee(numposte, token, True)
+
+# Download the applications of the candidates in the specified directory
+odyssee.download_applications('dossiers_candidats')
+
 candidates = odyssee.get_candidates()
 print(candidates)
 
@@ -70,7 +82,7 @@ print(candidates_with_details)
 # odyssee.assign_jury_members_to_candidate("f1e2d3c4-b5a6-4789-9876-543210fedcba", "98765432-10fe-dcba-9876-543210fedcba", "abcd1234-5678-90ef-ghij-klmnopqrstuv")
 
 # Download the reports of the committee members for the candidates in the specified directory
-odyssee.downloadReports("rapportsOdyssee")
+odyssee.downloadReports("rapports_odyssee")
 
 # A l'issue de la première réunion du jury, enregistrer l'avis pour chaque candidat et les résultats du vote
 # odyssee.opinion_for_interview("f1e2d3c4-b5a6-4789-9876-543210fedcba", "A", "Motif audition", 16, 16, 0, 0, 16, 0)

{odysseeapi-0.0.1 → odysseeapi-0.2.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "odysseeapi"
-version = "0.0.1"
+version = "0.2.0"
 authors = [
   {name = "Géry Casiez", email = "gery.casiez@univ-lille.fr"},
 ]