MyGES V2 - Pypi package

👋 About The Project

1. Built With

⚙️ Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

1. Prerequisites

Prerequisites list of things you need to use the software and how to install them.

PyEnv
```
pip install pyenv
```
Python 3.9.5 (or greater)
```
pyenv virtualenv 3.9.5 NAME-ENV
```
Activate your Virtual Env
```
pyenv activate NAME-ENV
```
MyGES Package
```
pip install MyGES
```
Requests Package (to handle API Call)
```
pip install requests
```
(back to top)

2. Usage

Let’s started by creating your client to proceed your requests :

⚠️ Many dates that you can find in the routes are in EpochUnix (ms) format. ⚠️

If you want to get an understandable date, feel free to use the private fonction ‘_EpochUnixToDateTime(EpochUnixMsFormat)’ that I’ve just created for this project (you should get a DateTime format YYYY-MM-DD HH:MM:SS).

Example : create_date = 1694249045776 -> _EpochUnixToDateTime(create_date) = ‘2023-10-11 13:36:15’

from MyGES import MyGesClient

# Create your access to MyGES Client
client = MyGesClient(name='YOUR-ID', password='YOUR-PASSWORD')

🏫 - MyGES Section

# Access to all the informations in the banners of MyGES 
# (Img, links, texts, etc...)
mygesBanners = client.getBanners()

# Access to the list of all the partners of MyGES
mygesPartners = client.getPartners()

# Access to all the events promoted by MyGES 
mygesEvents = client.getEvents()

# Access to ICDL certification register informations
mygesIcdl = client.getIcdlInscription()

# Access to your profile informations
mygesProfile = client.getProfile()

# Access to your list of annual documents
mygesAnnualDocuments = client.getAnnualDocuments()

# Access to all the classes you've been through GES Network
mygesStudentsPeriode = client.getStudentPeriode()

# Access to all the "Opens" associations in your campus
mygesOpens = client.opens()

# Access to the information about your last campus
mygesStudentLastCampus = client.getStudentLastCampus()

(back to top)

📆 - Agenda Section

# Access to all the informations about your agenda between two dates
agendaStartEnd = client.getAgenda(start, end) # formated date : DD/MM/YY

# Access to all the informations about your agenda for the next month
agendaForNextMonth = client.getAgendaForTheNextMonth()

# Access to all the informations about next course
agendaNextCourse = client.getNextCourses(numberOfNextCourses)

(back to top)

👤 - Presence Section

# Access to all the informations about your previous absences
absencesListed = client.getAbsences()

# WIP - Maybe for the integration of Edusign (return nothing actually)
presenceAttestation = client.getPresenceAttestations()

(back to top)

📊 - Grade Section

# Access to all the informations about your grades for the actual year
gradeForActualYear = client.getGrades()

# Access to all the informations about your grades about a precise year
gradeForSpecificYear = client.getYearGrades(year)

(back to top)

📖 - Project Section

To get your project_id, you have to use the call ‘client.getProjects()’ route or ‘client.getSimpleProjects()’ route (I recommand the second one for the lisibility)

# Access to all the informations about your projects for the actual year
actualProject = client.getProjects()

# Access to important informations (only) about your projects for 
# the actual year
projectSimpleInformations = client.getSimpleProjects()

# Access to your next project steps (steps to be delivered)
projectNextSteps = client.getNextProjectsSteps()

# Access to all the informations about one specific project
projectFocus = client.getProjectsInformations(project_id)

# Access to the subject of a specific project
projectSubject = client.getProjectSubject(project_id)

# Access to the planning of a specific project
projectPlanning = client.getProjectPlanning(project_id)

# Access to the students list of a specific project
projectStudents = client.getProjectStudents(project_id)

(back to top)

📚 - Courses Section

To get your course_id, you have to use the call ‘client.getCourses()’ route

# Access to all the informations about your courses for the actual year
coursesForActualYear = client.getCourses()

# Access to all the documents about a specific courses
coursesDocuments = client.getCourseDocuments(course_id)

(back to top)

👨‍🏫 - Teachers Section

# Access to all the informations about your teachers for the actual year
teachersForActualYear = client.getTeachers()

(back to top)

🏴󠁧󠁢󠁥󠁮󠁧󠁿 - TOEIC Section

# Access to your previous TOEIC result(s)
toeicResults = client.getToeicResult()

# Access to the informations about your previous TOEIC session(s)
toeicSessions = client.getToeicSessions()

# Access to the informations about your previous TOEIC transaction(s)
toeicTransaction = client.getToeicTransaction()

# Access to the informations about the next TOEIC date(s)
toeicNextDates = client.getNextToeicDates()

# Access to your previous TOEIC result(s)
toeicResults = client.getToeicResult()