BirthdayReminderApp

Приложение напоминания о день рождения

Программа проверяет, есть ли у человека день рождения в течение недели и при желании отправляет напоминания остальной части группы. Он включает в себя необходимые функции для проверки ввода и отправки электронных писем. Этот репозиторий содержит 2 модуля , где 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, но в вашем каталоге. Полным путем для меня будет/Ousers/aurimasnausedas/documents/python/birthdayreminderapp/datasets/data_20.csv

² Основной модуль принимает два аргумента при запуске из консоли.

³ Данные, используемые для примеров, были Data_20.csv ²³ июня 2022 года.

Функции

Обзор функций, найденных в модуле - bdayReminder.py :

• validate_data_and_send_emails (input_file, send_emails) проверяет обоснованность opt_file и является ли день рождения через неделю, а также при необходимости отправляет соответствующие электронные письма ( 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 (имя, 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 ).
• Select_options (read_path) запрашивает для ввода ( read_path ) и выбирает опцию для запуска.

Глубокие объяснения функций можно найти внутри модуля - bdayReminder.py.

Наборы данных

Есть три возможных набора данных для использования. Это DATA_20 из 20 получателей, DATA_50 из 50 получателей и DATA_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_MONTH_DAY () Тестирует, если старая дата - в прошлом.
• TEST_IS_VALID_EMAIL_GOOD () Тестирует, если адрес электронной почты действителен.
• TEST_IS_VALID_EMAIL_BAD () Тестирует, если адрес электронной почты недействителен.

Навигация в папку Program/App, где она извлечена - BirthdayReminderApp - одна папка до того, как проводится tests.py, и можно запустить эти команды тестирования:

1. Чтобы проверить исходные файлы на наличие ошибок в папке проекта:

 >>> pyflakes .

2. Чтобы проверить исходные файлы на наличие ошибок в тестовом файле:

 >>> pyflakes Tests/tests.py

3. Чтобы проверить набор файлов тестирования:

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

Ошибки

Может возникнуть несколько ошибок, таких как:

1. 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. 1 -я ошибка аргумента, если предоставленный 1 -й аргумент файла данных не существует:

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

Есть еще больше, что это будет наиболее распространенным.

Крон. Работа

Чтобы построить работу 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> - должен быть каталог, где папка «День рождения» похожа на/aurmasnausedas/documents/python/birthdayReminderpp

² <Directory_to_python> должен быть там, где вы установили Python на вашем компьютере, например, пользователи/aurimasnausas/opt/miniconda3/envs/symmetric/bin/python

³ <ta Data_file_path> должен быть набором данных в каталоге приложения, как в/пользователя/aurimasnausedas/documents/python/birthdayReminderApp, установив его для наборов данных/data_20.csv

Настройка синтаксиса для работы Cron можно проверить здесь.

Публичный

Общественная папка содержит три файла:

• День рождения.
• Todolist - список дел.

Логотип

Логотип приложения напоминания о день рождения можно найти здесь.

Лицензия

Лицензия MIT