BirthdayReminderApp

Aplicación de recordatorio de cumpleaños

El programa verifica si una persona tiene un cumpleaños en una semana y opcionalmente envía recordatorios al resto del grupo. Implica las funcionalidades necesarias para validar la entrada y enviar correos electrónicos. Este repositorio contiene 2 módulos donde bdayreminder.py implica estas funcionalidades mientras prueba. Consulte los requisitos para la importación de bibliotecas, paquetes y módulos adicionales antes de observar el uso de la aplicación o funciones, pruebas, trabajo cron y otros campos.

Tabla de contenido

• Tabla de contenido
• Requisitos
• Variables de entorno
• Autenticación
• Uso
• Funciones
• Conjuntos de datos
• Pruebas
• Error
• Trabajo cron
• Público
• Logo
• Licencia

Requisitos

Se requiere Python 3.9.12 para ejecutar correctamente los módulos del paquete, las bibliotecas importadas y las funciones definidas. También se necesitan importaciones de varias bibliotecas como Dotnet, Pytest, por nombrar algunas. Algunas versiones requeridas se encuentran aquí, mientras que las que no se mencionan vienen con la versión Python usada. También inspeccione las variables de entorno y la autenticación antes de continuar. Para el uso adecuado del programa, es posible que necesite ejecutar Python3 en lugar del Python propuesto como se muestra en el uso. ¹

¹ Python o Python3 depende de la forma en que instaló Python en su máquina.

Variables de entorno

Para poder enviar correos electrónicos, deberá configurar las variables de entorno. Para hacer esto localmente, cree un archivo .env y agregue dos variables ENV con valores válidos, como este: ¹

 USR=<youremail>
PSW=<yourpassword> or <token>

¹ Si enviará desde Gmail, para configurar la contraseña de variable de entorno adecuada, deberá crear un token. Más información sobre esto en la sección de autenticación.

Autenticación

Para poder enviar el correo electrónico después de configurar el correo electrónico de Gmail en el entorno variable, deberá crear un token. Los detalles sobre cómo hacerlo se pueden encontrar aquí.

Uso

Después de cumplir con los requisitos, el paquete de la aplicación se establece en su directorio y se ejecuta el terminal, tiene cuatro opciones ^1,2,3 :

1. Para permitirse ejecutar la validación o verificar y enviar proporcionar el archivo de Python y el archivo de datos como argumentos. Luego se le pedirá que elija la opción 1 (validar) o 2 (validar y enviar):

 >>> python bdayreminder.py <data_file_path>
Choose 1 to validate if input data file is correct or 2 to check for upcoming birthdays and send respective emails
>>> 1
ERROR: Invalid email for Laura Dreyfuss at row 6 
ERROR: Empty name field is for email [email protected] at row 7 
ERROR: Invalid date for Anna Higgins at row 11. Date given is 02-30 
ERROR: Date is in the future for Tom Brady at row 12. Date given is 2075-10-22 
ERROR: Invalid email for Ching Yeung Michael Tam at row 19
'''
'''
>>> python bdayreminder.py <data_file_path>
Choose 1 to validate if input data file is correct or 2 to check for upcoming birthdays and send respective emails
>>> 2
Kai Yuen Leung will have birthday in a week.
Patrick Kienzle will have birthday in a week.
Emails sent successfully.

2. Para ejecutar la validación o verificar y enviar proporcionar el archivo Python, el archivo de datos y cualquier número que no sea 1 o 2 como argumentos. Luego se le solicitará elige la opción 1 (validar) o 2 (validar y enviar), ya que ningún otro número son opciones:

 >>> python bdayreminder.py <data_file_path> 3
Choose 1 to validate if input data file is correct or 2 to check for upcoming birthdays and send respective emails
>>> 3
Please choose either 1 or 2
>>> 1
ERROR: Invalid email for Laura Dreyfuss at row 6 
ERROR: Empty name field is for email [email protected] at row 7 
ERROR: Invalid date for Anna Higgins at row 11. Date given is 02-30 
ERROR: Date is in the future for Tom Brady at row 12. Date given is 2075-10-22 
ERROR: Invalid email for Ching Yeung Michael Tam at row 19 

3. Puede evitar que se le muestre el indicador por completo. Para validar el archivo de datos de las personas de cumpleaños, los errores establecen el segundo argumento en 1 :

 >>> python bdayreminder.py <data_file_path> 1
ERROR: Invalid email for Laura Dreyfuss at row 6 
ERROR: Empty name field is for email [email protected] at row 7 
ERROR: Invalid date for Anna Higgins at row 11. Date given is 02-30 
ERROR: Date is in the future for Tom Brady at row 12. Date given is 2075-10-22 
ERROR: Invalid email for Ching Yeung Michael Tam at row 19

4. Para verificar el archivo de datos de las personas de cumpleaños y enviar correos electrónicos establece que el segundo argumento sea 2 :

 >>> python bdayreminder.py <data_file_path> 2
Kai Yuen Leung will have birthday in a week.
Patrick Kienzle will have birthday in a week.
Emails sent successfully.

¹ <Cets_File_Path> debería verse así - DataSets/Data_20.CSV, pero en su directorio. La ruta completa para mí sería /users/aurimasnausedas/documents/python/birthdayreminderapp/datasets/data_20.csv

² El módulo principal toma dos argumentos cuando se ejecuta desde la consola.

³ Los datos utilizados para ejemplos fueron data_20.csv el ²³ de junio de 2022.

Funciones

Una descripción general de las funciones encontradas dentro de un módulo - bdayreminder.py :

• Validate_data_and_send_emails (input_file, send_emails) verifica la validez de un Input_File y si un cumpleaños está en una semana y opcionalmente envía los correos electrónicos respectivos ( Send_Emails ).
• parse_date (fecha) analiza la fecha .
• is_valid_input (date_format, item, index, to_print) valida las entradas ( date_format , item , index , to_print ).
• send_multiple_emails (birthday_individuals, to_send) envía correos electrónicos a los destinatarios de la lista To_send .
• IS_DATE_IN_PAST (date, date_format) se ve si la fecha está en el pasado.
• IS_VALID_EMAIL (correo electrónico) Comprueba si un correo electrónico es válido.
• send_email (nombre, bday_name, bday_date, days_left, to_email) envía un correo electrónico a un destinatario ( nombre , to_email ) como un recordatorio de un cumpleaños ( bday_name , bday_date ) de antemano ( days_left ).
• Run (read_path, cron_value) toma el archivo de datos CSV y ejecuta el script sin que las elecciones se pasan como argumentos ( read_path , cron_value ).
• elegir_options (read_path) solicita la entrada ( read_path ) y elige la opción para ejecutar.

Las explicaciones en profundidad de las funciones se pueden encontrar dentro de un módulo: bdayreminder.py.

Conjuntos de datos

Hay tres conjuntos de datos posibles para usar. Estos son Data_20 de 20 destinatarios, Data_50 de 50 destinatarios y Data_80 de 80 destinatarios.

Pruebas

Una descripción general de las funciones encontradas dentro de un módulo - Tests.py:

• test_correct_parse_date_ymd () prueba si se analiza la fecha correcta.
• test_correct_parse_date_md () prueba si se analiza la fecha correcta.
• test_is_date_in_past_old () prueba si la fecha anterior está en el pasado.
• test_is_date_in_past_future () prueba si la fecha futura está en el pasado.
• test_is_date_in_past_past_month_day () prueba si la fecha anterior está en el pasado.
• test_is_valid_email_good () prueba si la dirección de correo electrónico es válida.
• test_is_valid_email_bad () prueba si la dirección de correo electrónico no es válida.

Al navegar a la carpeta del programa/aplicaciones donde se extrae - cumpleañosreminderApp - una carpeta antes de donde se mantiene las pruebas. By y uno puede ejecutar estos comandos de prueba:

1. Para verificar los archivos de origen en busca de errores en la carpeta del proyecto:

 >>> pyflakes .

2. Para verificar los archivos de origen en busca de errores en el archivo de prueba:

 >>> pyflakes Tests/tests.py

3. Para verificar la escritura para el archivo de prueba:

 >>> python -m pytest Tests/tests.py

Errores

Podría surgir algunos errores como:

1. 1er error de argumento Si el primer argumento proporcionado es de diferente formato al formato CSV:

 >>> python bdayreminder.py Datasets/data_20.json 1      
Traceback (most recent call last):
  File "/Users/aurimasnausedas/Documents/Python/BirthdayReminderApp/bdayreminder.py", line 237, in <module>
    run(arg_path, cron_input)
  File "/Users/aurimasnausedas/Documents/Python/BirthdayReminderApp/bdayreminder.py", line 215, in run
    raise Exception('ERROR: Wrong data format file')
Exception: ERROR: Wrong data format file

2. 1er error de argumento Si el primer argumento proporcionado del archivo de datos no existe:

 >>> python bdayreminder.py Datasets/data_13.csv 1 
Traceback (most recent call last):
  File "/Users/aurimasnausedas/Documents/Python/BirthdayReminderApp/bdayreminder.py", line 237, in <module>
    run(arg_path, cron_input)
  File "/Users/aurimasnausedas/Documents/Python/BirthdayReminderApp/bdayreminder.py", line 199, in run
    raise Exception('ERROR: File doesn't exist')
Exception: ERROR: File doesn't exist

3. Segundo error de argumento si el segundo argumento proporcionado es una cadena:

 >>>  python bdayreminder.py Datasets/data_20.csv versada
Argument passed not an integer

Todavía hay más, estos serían los más comunes.

Trabajo cron

Para construir el trabajo cron en la ejecución de la terminal Mac:

 >>> crontab -e

La sintaxis para Cronjob al ingresar al terminal podría verse así: ^1,2,3

 >>> 0 6 * * * cd <directory_to_app> && <directory_to_python> bdayreminder.py <data_file_path> 2
[Optional] >>> 0 6 * * * cd <directory_to_app> && <directory_to_python> bdayreminder.py <data_file_path> 2 >> Public/birthdays.txt

¹ <Rirectory_To_App> - Debe ser el directorio donde la carpeta BirthrenyreminderApp es como/usuarios/aurimasnausedas/documentos/python/birthdlereminderappapp

² <Rirectory_to_python> Debería estar donde instaló Python en su máquina como/usuarios/aurimasnausedas/opt/miniconda3/envs/simétrico/bin/python

³ <Data_file_path> debe ser el conjunto de datos en el directorio de APP como In/Users/AuriMasnausedas/Documents/Python/BirthdyreminderApp al configurarlo en DataSets/Data_20.CSV

La personalización de sintaxis para el trabajo cron se puede verificar aquí.

Público

La carpeta pública contiene tres archivos:

• cumpleaños.txt: la salida de un trabajo cron después de implementar el comando [opcional] como se da en el campo de trabajo cron.
• Todolista: la lista de tareas.

Logo

El logotipo de la aplicación de recordatorio de cumpleaños se puede encontrar aquí.

Licencia

La licencia del MIT