https://github.com/medsagou/massar-sagoubot
This is bot will helps teachers of morocco to enter the points in massar site
https://github.com/medsagou/massar-sagoubot
Last synced: 4 months ago
JSON representation
This is bot will helps teachers of morocco to enter the points in massar site
- Host: GitHub
- URL: https://github.com/medsagou/massar-sagoubot
- Owner: medsagou
- License: gpl-3.0
- Created: 2023-10-24T22:30:01.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-10-27T16:49:08.000Z (over 1 year ago)
- Last Synced: 2025-01-03T19:26:50.753Z (6 months ago)
- Language: Python
- Size: 39.1 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
MASSAR-SAGOUBOT
◦ By: MedSagou
◦ Developed with the software and tools below.
---
## 📖 Table of Contents
- [📖 Table of Contents](#-table-of-contents)
- [📍 Overview](#-overview)
- [📦 Features](#-features)
- [📂 repository Structure](#-repository-structure)
- [⚙️ Modules](#modules)
- [🚀 Getting Started](#-getting-started)
- [🔧 Installation](#-installation)
- [🤖 Running massar-sagoubot](#-running-massar-sagoubot)
- [🤝 Contributing](#-contributing)
- [📄 License](#-license)
- [👏 Acknowledgments](#-acknowledgments)
---
## 📍 Overview
The "massar-sagoubot" repository is a Python project that provides automation capabilities for interacting with a Massar website. It includes functionality for automating the extraction and saving of class lists from the website. The codebase consists of several modules, each responsible for specific tasks, such as interacting with directories, working with files, automating website interaction, and extracting and saving class lists. This project is valuable for anyone who needs to automate the process of extracting and saving class lists from a Massar website.
---
## 📦 Features
**Key Features:**
- **Effortless Class List Extraction**: Massar Sagoubot automates the process of retrieving class lists, allowing teachers to focus on what truly matters – teaching.
- **Customization**: Teachers have the flexibility to customize the bot's settings to match their unique needs and preferences.
- **User-Friendly Interface**: The bot is designed with an intuitive and accessible interface, ensuring that both tech-savvy and non-technical educators can harness its power.
- **Time-Saving Automation**: With repetitive administrative tasks handled by the bot, teachers can invest more time in the classroom.
---
## 📂 Repository Structure
```sh
└── massar-sagoubot/
├── Class_Files.py
├── interaction.py
├── list_reader.py
├── main.py
├── Menu.py
├── Module_Classe_Liste.py
├── print_sagou.py
└── ui.py
```
---
## ⚙️ Modules
Root
| File | Summary |
| --- |-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [Class_Files.py](https://github.com/medsagou/massar-sagoubot/blob/main/Class_Files.py) | The code consists of two class definitions: C_Dossier and C_File. The C_Dossier class includes methods to interact with directories, such as getting the current directory, checking if a directory exists, changing the current directory, and creating a new directory. It utilizes the os and os.path modules.The C_File class is used to work with files. It includes methods to check if a file exists, specify the name of a file, and instantiate a new file object. The class also allows for specifying a separator for file elements. |
| [interaction.py](https://github.com/medsagou/massar-sagoubot/blob/main/interaction.py) | The code defines a class called "Massar_Sagou" that contains methods for automating the interaction with a website. The class has methods for initializing the web driver, opening the website, filling in the username and password fields, submitting the login form, checking for login errors, extracting class information from the main page, and exporting data. The class also has methods for closing the web driver and exiting the program. |
| [list_reader.py](https://github.com/medsagou/massar-sagoubot/blob/main/list_reader.py) | The code above implements a class called `List_Reader`, which is responsible for extracting and saving class lists from a Massar website. It uses the Selenium library to automate the web scraping process. The `List_Reader` class has methods for navigating to the list page, selecting different class options, and extracting the data from the table. The `main_list_reader` method calls the other methods in the correct order to perform the desired functionality. |
| [main.py](https://github.com/medsagou/massar-sagoubot/blob/main/main.py) | The main file |
| [Menu.py](https://github.com/medsagou/massar-sagoubot/blob/main/Menu.py) | Menu management |
| [Module_Classe_Liste.py](https://github.com/medsagou/massar-sagoubot/blob/main/Module_Classe_Liste.py) | List management |
| [print_sagou.py](https://github.com/medsagou/massar-sagoubot/blob/main/print_sagou.py) | Custom printing Functions |
| [ui.py](https://github.com/medsagou/massar-sagoubot/blob/main/ui.py) | User interface |
---
## 🚀 Getting Started
### 🔧 Installation
1. Clone the massar-sagoubot repository:
```sh
git clone https://github.com/medsagou/massar-sagoubot
```
2. Change to the project directory:
```sh
cd massar-sagoubot
```
3. Install the dependencies:
```sh
pip install -r requirements.txt
```
### 🤖 Running massar-sagoubot
```sh
python main.py
```
---
## 🤝 Contributing
Contributions are welcome! Here are several ways you can contribute:
- **[Submit Pull Requests](https://github.com/medsagou/massar-sagoubot/blob/main/CONTRIBUTING.md)**: Review open PRs, and submit your own PRs.
- **[Join the Discussions](https://github.com/medsagou/massar-sagoubot/discussions)**: Share your insights, provide feedback, or ask questions.
- **[Report Issues](https://github.com/medsagou/massar-sagoubot/issues)**: Submit bugs found or log feature requests for medsagou.
#### *Contributing Guidelines*
Click to expand
1. **Fork the Repository**: Start by forking the project repository to your GitHub account.
2. **Clone Locally**: Clone the forked repository to your local machine using a Git client.
```sh
git clone
```
3. **Create a New Branch**: Always work on a new branch, giving it a descriptive name.
```sh
git checkout -b new-feature-x
```
4. **Make Your Changes**: Develop and test your changes locally.
5. **Commit Your Changes**: Commit with a clear and concise message describing your updates.
```sh
git commit -m 'Implemented new feature x.'
```
6. **Push to GitHub**: Push the changes to your forked repository.
```sh
git push origin new-feature-x
```
7. **Submit a Pull Request**: Create a PR against the original project repository. Clearly describe the changes and their motivations.
Once your PR is reviewed and approved, it will be merged into the main branch.
---
## 📄 License
This project is protected under the [GPL-3.0](https://choosealicense.com/licenses/gpl-3.0/) License.
---
## 👏 Acknowledgments
- **Previous Work:** If your project builds upon or is inspired by previous work, give credit to the original authors or researchers.
- **Self-Acknowledgment:** Don't forget to acknowledge your own efforts and commitment to the project. It's an opportunity to reflect on your own growth and learning throughout the project.
[**Return**](#Top)
---