BirthdayReminderApp BirthdayReminderApp -ThirmbyreMinderApp源代碼下載

BirthdayReminderApp

其他源碼

1.0.0

下載

生日提醒申請

該計劃檢查一個人是否在一周內有生日，並可選地將提醒發送給小組的其餘部分。它涉及驗證輸入和發送電子郵件的必要功能。該存儲庫包含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 ：

為了讓自己運行驗證或檢查並發送提供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.

要運行驗證或檢查並發送提供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

您可以避免將提示完全顯示給您。為了驗證生日人數據文件的錯誤，將第二個參數設置為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

檢查生日人數據文件，然後發送電子郵件將第二個參數設置為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之前的一個文件夾，可以運行以下測試命令：

要檢查源文件中的項目文件夾中的錯誤：

 >>> pyflakes .

要檢查源文件中是否有測試文件中的錯誤：

 >>> pyflakes Tests/tests.py

檢查鍵入測試文件：

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

錯誤

可能出現一些錯誤，例如：

第一個參數錯誤如果提供的第一參數與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

第一個參數錯誤如果提供的數據文件的第一個參數不存在：

 >>> 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

第二個參數錯誤如果提供的第二個參數是字符串：

 >>>  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作業的語法自定義。