BirthdayReminderApp

تطبيق تذكير عيد الميلاد

يتحقق البرنامج ما إذا كان لدى الشخص عيد ميلاد في غضون أسبوع ويرسل اختياريًا تذكيرات إلى بقية المجموعة. يتضمن الوظائف اللازمة للتحقق من صحة المدخلات وإرسال رسائل البريد الإلكتروني. يحتوي هذا المستودع على وحدتين حيث يتضمن BdayReminder.py هذه الوظائف بينما يختبر Tests.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> يجب أن تبدو مثل هذه - مجموعات البيانات/data_20.csv ، ولكن في الدليل الخاص بك. المسار الكامل بالنسبة لي سيكون/Uaurimasnausedas/documents/python/birthdayReminderapp/Datasets/Data_20.csv

² الوحدة الرئيسية تأخذ وسيطتين عند الركض من وحدة التحكم.

³ كانت البيانات المستخدمة للأمثلة data_20.csv في ²³ يونيو 2022.

وظائف

نظرة عامة على الوظائف الموجودة داخل الوحدة النمطية - bdayreminder.py :

• تقوم Validate_Data_and_send_emails (input_file ، send_emails) بالتحقق من صحة input_file وما إذا كان عيد ميلاد في الأسبوع وكذلك إرسال رسائل البريد الإلكتروني ذات الصلة ( send_emails ).
• parse_date (التاريخ) يوسع التاريخ .
• is_valid_input (date_format ، العنصر ، الفهرس ، to_print) يتحقق من صحة المدخلات ( date_format ، العنصر ، الفهرس ، to_print ).
• Send_multiple_emails (عيد ميلاد_الفراد ، TO_SEND) يرسل رسائل البريد الإلكتروني إلى مستلمي قائمة TO_SEND .
• IS_DATE_IN_PAST (DATE ، DATE_FORMAT) يبحث إذا كان التاريخ في الماضي.
• is_valid_email (البريد الإلكتروني) يتحقق إذا كان البريد الإلكتروني صالحًا.
• Send_email (الاسم ، bday_name ، bday_date ، days_left ، to_email) يرسل بريدًا إلكترونيًا إلى مستلم ( اسم ، to_email ) كتذكير بعيد ميلاد ( bday_name ، bday_date ) مقدما ( days_left ).
• Run (read_path ، cron_value) يأخذ ملف بيانات CSV ويقوم بتشغيل البرنامج النصي دون أن يتم تمرير الخيارات كوسائط ( read_path ، cron_value ).
• اختيار inction_options (read_path) يسأل عن الإدخال ( read_path ) ويختار الخيار للتشغيل.

يمكن العثور على تفسيرات متعمقة للوظائف داخل الوحدة النمطية - BdayReminder.py.

مجموعات البيانات

هناك ثلاث مجموعات بيانات ممكنة لاستخدامها. هذه هي Data_20 من 20 مستلم ، Data_50 من 50 مستلم و Data_80 من 80 مستلم.

الاختبارات

نظرة عامة على الوظائف الموجودة داخل الوحدة النمطية - الاختبارات.

• اختبار 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 () إذا كان عنوان البريد الإلكتروني غير صالح.

من خلال الانتقال إلى مجلد البرنامج/التطبيق حيث يتم استخلاصه - عيد ميلاد - مجلد واحد قبل أن يتم إجراء اختبار.

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

هناك ما هو أكثر من ذلك سيكون الأكثر شيوعا.

عمل كرون

لبناء وظيفة cron في Mac Terminal Run:

 >>> 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> - يجب أن يكون الدليل حيث يكون مجلد عيد ميلاد/مستخدمين/Aurimasnausedas/Documents/Python/BirthdyReminderapp

² <directory_to_python> يجب أن يكون حيث قمت بتثبيت python على جهازك مثل/المستخدمين/aurimasnausedas/opt/miniconda3/envs/symmetric/bin/python

³ <data_file_path> يجب أن تكون مجموعة البيانات في دليل التطبيق مثل in/user/aurimasnausedas/documents/python/birthdayReminderapp من خلال إعداده على مجموعات البيانات/data_20.csv

يمكن التحقق من تخصيص بناء الجملة لوظيفة CRON هنا.

عام

يحتوي المجلد العام على ثلاثة ملفات:

• أعياد الميلاد. txt - إخراج وظيفة CRON بعد تنفيذ الأمر [الاختياري] على النحو الوارد في حقل JOB CRON.
• Todolist - قائمة المهام.

شعار

يمكن العثور على شعار تطبيق تذكير عيد الميلاد هنا.

رخصة

ترخيص معهد ماساتشوستس للتكنولوجيا