https://github.com/andres15alvarez/attendance-processor
CLI app to proccess students' class attendance via text file
https://github.com/andres15alvarez/attendance-processor
Last synced: 2 months ago
JSON representation
CLI app to proccess students' class attendance via text file
- Host: GitHub
- URL: https://github.com/andres15alvarez/attendance-processor
- Owner: andres15alvarez
- License: gpl-3.0
- Created: 2024-04-18T22:23:51.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-04-19T21:56:52.000Z (about 1 year ago)
- Last Synced: 2025-01-17T13:29:32.738Z (4 months ago)
- Language: Python
- Homepage:
- Size: 20.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Attendance Processor
### This project is a CLI app to proccess students attendance and generate reports of the time spends in class
Prerequisites of the project:
- Python 3.11
- Virtualenv 20.25.3
## Create the virtual environment
```bash
$ virtualenv venv -p python3.11
```
Onche the virtual environemnt is created, you need to activate it
```bash
$ source venv/bin/activate
```
Then install the requirements.
```bash
$ pip install -r requirements.txt
```
Activate pre-commit hooks
```bash
$ pre-commit install
```
## Run the project
As a CLI app you can obtain information about the usage of the command, so you can get the infomation with:
```bash
$ python manage.py --help
```
And get the help text
```bash
Usage: main.py [OPTIONS] FILE
Attendance Processor.
╭─ Arguments ────────────────────────────────────────────────────────────────────────────╮
│ * file TEXT Filepath of the TXT file to process [default: None] [required] │
╰────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Options ──────────────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰────────────────────────────────────────────────────────────────────────────────────────╯
```
The file `fixture.txt` contain dummy data to test the CLI.
## Example
```bash
$ python manage.py fixture.txt
```
# Analisis del Proyecto
Para empezar el proyecto escogi como lenguage Python, ya que es el lenguaje que mas domino y un lenguaje excelente para crear aplicaciones de interfaz de comando.
Para mantener el codigo bien estructurado, decidi usar black y flake8 como linters, ademas de agregar pre-commit para que realizara las validaciones siempre que se hace un commit y reformatear los archivos de ser necesario.
Escogi instalar una libreria llamada Typer para facilitar la documentacion del comando, al ser una libreria creada por el mismo creador de FastAPI da bastante confianza y esta bien documentada.
Decidi usar programacion orientada a objetos para modelar al estudiante y al procesador de asistencias, dividiendo las responsabilidades de manera clara, ya que el Processor se encargaria de manejar los comandos en string recibiendo los parametros en string y dandoles el manejo necesario, mientras que la clase Student manejaria los datos ya procesador y de solo un estudiante.