BirthdayReminderApp

誕生日リマインダーアプリケーション

このプログラムは、人が1週間で誕生日を迎えるかどうかを確認し、オプションでグループの残りの部分にリマインダーを送信します。入力を検証してメールを送信するために必要な機能が含まれます。このリポジトリには、bdayreminder.pyがこれらの機能を含む2つのモジュールが含まれています。アプリまたは機能、テスト、Cronジョブ、その他のフィールドの使用を検討する前に、ライブラリ、パッケージ、追加モジュールをインポートするための要件を参照してください。

目次

• 目次
• 要件
• 環境変数
• 認証
• 使用法
• 関数
• データセット
• テスト
• エラー
• クロンの仕事
• 公共
• ロゴ
• ライセンス

要件

Python 3.9.12は、パッケージのモジュール、インポートされたライブラリ、および定義された機能を適切に実行するために必要です。 Dotnet、Pytestなどのいくつかのライブラリのインポートも必要です。必要なバージョンはここにありますが、言及されていないバージョンには使用済みのPythonバージョンが付属しています。また、さらに進める前に、環境変数と認証を検査します。プログラムを適切に使用するには、使用法に示されているように、 Pythonを提案するのではなく、 Python3を実行する必要がある場合があります。 ¹

¹ PythonまたはPython3は、マシンにPythonをインストールする方法に依存します。

環境変数

メールを送信できるようにするには、環境変数を設定する必要があります。これをローカルに行うには、 .envファイルを作成し、有効な値で2つのENV変数を追加してください^。

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

¹ Gmailから送信する場合は、適切な環境変数パスワードを設定するには、トークンを作成する必要があります。これについては、認証セクションの詳細について。

認証

環境変数にGmailメールを設定した後にメールを送信できるようにするには、トークンを作成する必要があります。それを行う方法の詳細はこちらをご覧ください。

使用法

要件が満たされた後、アプリパッケージがディレクトリに設定され、端末が実行されます^1,2,3 ：4つのオプションがあります。

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. プロンプトを完全に表示することを避けることができます。誕生日の人を検証するために、エラーのデータファイルは2番目の引数を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番目の引数を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>は、このように見えるはずです-DataSets/data_20.csvですが、ディレクトリにあります。私にとってのフルパスは/users/aurimasnauedas/documents/python/birthdayreminderapp/datasets/data_20.csvです

²メインモジュールは、コンソールから実行すると2つの引数を取ります。

³例で使用されたデータは、2022年6月23^日のdata_20.csvでした。

関数

モジュール内で見つかった関数の概要-bdayreminder.py ：

• validate_data_and_send_emails（input_file、send_emails） input_fileの有効性と、誕生日が1週間であるかどうか、およびオプションでそれぞれの電子メール（ send_emails ）を送信するかどうかをチェックします。
• parse_date（日付）は日付を解析します。
• is_valid_input（date_format、item、index、to_print）入力（ date_format 、 item 、 index 、 to_print ）を検証します。
• send_multiple_emails（Birthday_individuals、to_send） to_sendリストの受信者にメールを送信します。
• is_date_in_past（date、date_format）は、日付が過去にあるかどうかを確認します。
• is_valid_email（電子メール）メールが有効かどうかを確認します。
• send_email（name、bday_name、bday_date、days_left、to_email）事前（ days_left ）の誕生日（ bday_name 、 bday_date ）のリマインダーとして受信者（ name 、 to_email ）にメールを送信します。
• run（read_path、cron_value）は、CSVデータファイルを取得し、選択肢が引数として渡されるとスクリプトを実行します（ read_path 、 cron_value ）。
• shoice_options（read_path）入力（ read_path ）を要求し、実行するオプションを選択します。

機能の詳細な説明は、モジュールの内部であるbdayreminder.pyです。

データセット

使用する3つのデータセットがあります。これらは、20人の受信者のデータ_20、50人の受信者のデータ_50、80人のレシピエントのdata_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_month_day（）テスト古い日付が過去にあるかどうかをテストします。
• test_is_valid_email_good（）メールアドレスが有効かどうかをテストします。
• test_is_valid_email_bad（）メールアドレスが無効であるかどうかをテストします。

抽出されているプログラム/アプリフォルダーに移動することにより-BARTHINDREMINDERAPP-テストの1つのフォルダーが保持され、これらのテストコマンドを実行できます。

1. プロジェクトフォルダーのエラーについてソースファイルを確認するには：

 >>> pyflakes .

2. テストファイルのエラーをソースファイルを確認するには：

 >>> pyflakes Tests/tests.py

3. テストファイルのタイピングを確認するには：

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

エラー

次のようないくつかのエラーが発生する可能性があります。

1. 最初の引数エラー提供された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. 2番目の引数エラー提供された2番目の引数が文字列である場合：

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

これらが最も一般的なものがまだあります。

クロンの仕事

Macターミナルの実行でCronジョブを構築するには：

 >>> 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> -BathingReminderAppフォルダーが/users/aurimasnauseass/documents/python/bathindreminderappのようなディレクトリである必要があります

² <Directory_to_python>は、マシンにPythonをインストールした場所にある必要があります。

³ <data_file_path>は、in/users/aurimasnauseas/documents/python/bashindreminderappのようなアプリのディレクトリのデータセットである必要があります。データセット/data_20.csvに設定します

Cronジョブの構文のカスタマイズは、こちらで確認できます。

公共

パブリックフォルダーには3つのファイルが含まれています。

• Birthingdays.txt -Cronジョブフィールドで与えられた[オプション]コマンドを実装した後のCronジョブの出力。
• Todolist -to do list。

ロゴ

誕生日リマインダーアプリケーションのロゴはこちらにあります。

ライセンス

MITライセンス