BirthdayReminderApp

生日提醒申请

该计划检查一个人是否在一周内有生日，并可选地将提醒发送给小组的其余部分。它涉及验证输入和发送电子邮件的必要功能。该存储库包含2个模块，其中bdayReminder.py在测试时涉及这些功能。在查看应用程序或功能，测试，CRON作业和其他字段之前，请参阅导入库，软件包和附加模块的要求。

目录

• 目录
• 要求
• 环境变量
• 验证
• 用法
• 功能
• 数据集
• 测试
• 错误
• 克朗工作
• 民众
• 标识
• 执照

要求

需要Python 3.9.12才能正确执行软件包的模块，导入的库和定义的功能。还需要几个库，例如dotnet，pytest的名字。在此处找到一些必需的版本，而二手python版本则附有未提及的版本。还要检查环境变量和身份验证，然后再进行进一步进行。为了适当使用该程序，您可能需要运行Python3 ，而不是建议使用python 。 ¹

¹ Python或Python3取决于您在计算机上安装Python的方式。

环境变量

为了能够发送电子邮件，您需要设置环境变量。要在本地执行此操作，请创建一个.env文件，并以有效值添加两个Env变量，例如： ¹

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

¹如果您要从Gmail发送，然后设置适当的环境变量密码，则需要创建令牌。有关此基础验证部分的更多信息。

验证

为了能够在环境变量设置Gmail电子邮件之后发送电子邮件，您需要创建令牌。有关如何做的详细信息，请参见此处。

用法

满足要求后，将在您的目录处设置应用程序包并运行终端，您有四个选项^1,2,3 ：

1. 为了让自己运行验证或检查并发送提供Python文件和数据文件作为参数。然后，您将提示您选择选项1（验证）或2（验证并发送）：

 >>> 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. 要运行验证或检查并发送提供Python文件，数据文件和1或2以外的任何数字作为参数。然后，您将提示您选择选项1（验证）或2（验证和发送），因为没有其他数字是：

 >>> 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. 您可以避免将提示完全显示给您。为了验证生日人数据文件的错误，将第二个参数设置为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. 检查生日人数据文件，然后发送电子邮件将第二个参数设置为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.

¹ <data_file_path>应该看起来像这样-DataSet/data_20.csv，但在您的目录中。对我的完整道路是/Users/aurimasnausedas/documents/python/birthdayReminderapp/datasets/data_20.csv

²从控制台运行时，主模块需要两个参数。

³用于示例的数据是2022年6月23^日的Data_20.csv。

功能

在模块中找到的功能的概述-BdayReminder.py ：

• validate_data_and_send_emails（input_file，send_emails）检查input_file的有效性以及生日是否在一周之内以及可选地发送相应的电子邮件（ send_emails ）。
• parse_date（日期）解析日期。
• is_valid_input（date_format，item，index，to_print）验证输入（ date_format ， item ，item， index ， to_print ）。
• send_multiple_emails（生日_印度，to_send）将电子邮件发送给to_send列表的收件人。
• IS_DATE_IN_PAST（日期，date_format）如果日期在过去。
• IS_VALID_EMAIL（电子邮件）检查电子邮件是否有效。
• send_email（name，bday_name，bday_date，days_left，to_email）将电子邮件发送给收件人（名称， to_email ），以提醒生日（ bday_name ， bday_date ）（ days_left ）。
• 运行（read_path，cron_value）获取CSV数据文件，并在无需选择的情况下运行脚本作为参数（ read_path ， cron_value ）。
• select_options（read_path）要求输入（ read_path ），并选择运行的选项。

可以在模块-BdayReminder.py中找到对功能的深入解释。

数据集

有三个可能使用的数据集。这些是20个收件人中的data_20，50个收件人中的数据_50和80个收件人中的数据_80。

测试

在模块中找到的功能的概述-Tests.py：

• test_correct_parse_date_ymd（）测试是否对正确的日期进行解析。
• test_correct_parse_date_md（）测试如果正确的日期解析。
• test_is_date_in_past_old（）测试如果旧日期是过去。
• test_is_date_in_past_future（）测试如果未来日期是过去。
• test_is_date_in_past_past_past_month_day（）测试如果旧日期是过去。
• test_is_valid_email_good（）测试电子邮件地址是否有效。
• test_is_valid_email_bad（）测试电子邮件地址是否无效。

通过导航到提取的程序/应用程序文件夹-ThirmentReminderApp-保存tests.py之前的一个文件夹，可以运行以下测试命令：

1. 要检查源文件中的项目文件夹中的错误：

 >>> pyflakes .

2. 要检查源文件中是否有测试文件中的错误：

 >>> pyflakes Tests/tests.py

3. 检查键入测试文件：

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

错误

可能出现一些错误，例如：

1. 第一个参数错误如果提供的第一参数与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. 第一个参数错误如果提供的数据文件的第一个参数不存在：

 >>> 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. 第二个参数错误如果提供的第二个参数是字符串：

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

还有更多这些是最常见的。

克朗工作

在Mac终端运行中建立Cron Job：

 >>> crontab -e

进入终端时Cronjob的语法可能看起来像： ^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

¹ <Directory_to_app> - 应该是firtherminderapp文件夹的目录，例如/users/aurimasnausedas/documents/python/python/yaventreminderapp

² <Directory_to_python>应该是您在计算机上安装Python的位置，例如/users/aurimasnausedas/opt/miniconda3/envs/symmetric/symmetric/bin/python

³ <data_file_path>应该是应用程序目录中的数据集，例如/users/aurimasnausedas/documents/python/python/pythrominderapp，将其设置为数据集/data_20.csv

可以在此处检查Cron作业的语法自定义。

民众

公共文件夹包含三个文件：

• Birthdays.txt-在Cron Job Field实施[可选]命令后，Cron作业的输出。
• Todolist-待办事项列表。

标识

生日提醒申请的徽标可以在此处找到。

执照

麻省理工学院许可证