BirthdayReminderApp

Aplikasi Pengingat Ulang Tahun

Program memeriksa apakah seseorang berulang tahun dalam seminggu dan secara opsional mengirimkan pengingat ke seluruh grup. Ini melibatkan fungsionalitas yang diperlukan untuk memvalidasi input dan mengirim email. Repositori ini berisi 2 modul di mana bdayreminder.py melibatkan fungsi ini sementara tests.py menguji paket. Silakan merujuk ke persyaratan untuk mengimpor perpustakaan, paket, dan modul tambahan sebelum melihat penggunaan aplikasi atau fungsi, tes, pekerjaan cron, dan bidang lainnya.

Daftar isi

• Daftar isi
• Persyaratan
• Variabel Lingkungan
• Otentikasi
• Penggunaan
• Fungsi
• Kumpulan data
• Tes
• Kesalahan
• Pekerjaan cron
• Publik
• Logo
• Lisensi

Persyaratan

Python 3.9.12 diperlukan untuk menjalankan modul paket dengan benar, pustaka yang diimpor dan fungsi yang ditentukan. Impor beberapa perpustakaan seperti Dotnet, Pytest untuk beberapa nama juga diperlukan. Beberapa versi yang diperlukan ditemukan di sini sementara yang tidak disebutkan datang dengan versi python bekas. Juga memeriksa variabel lingkungan dan otentikasi sebelum melanjutkan lebih lanjut. Untuk penggunaan program yang tepat, Anda mungkin perlu menjalankan Python3 daripada yang diusulkan Python seperti yang ditunjukkan dalam penggunaan. ¹

¹ Python atau Python3 tergantung pada cara Anda memasang ular python di mesin Anda.

Variabel Lingkungan

Untuk dapat mengirim email, Anda perlu mengatur variabel lingkungan. Untuk melakukan ini secara lokal, silakan buat file .env dan tambahkan dua variabel env ke dalamnya dengan nilai yang valid, seperti ini: ¹

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

¹ Jika Anda akan mengirim dari Gmail maka untuk mengatur kata sandi variabel lingkungan yang tepat, Anda perlu membuat token. Info lebih lanjut tentang ini di bawah bagian otentikasi.

Otentikasi

Untuk dapat mengirim email setelah mengatur email Gmail di variabel lingkungan, Anda perlu membuat token. Detail tentang cara melakukannya dapat ditemukan di sini.

Penggunaan

Setelah persyaratan dipenuhi, paket aplikasi ditetapkan di direktori dan terminal Anda dijalankan, Anda memiliki empat opsi ^1,2,3 :

1. Untuk mengizinkan diri Anda menjalankan validasi atau memeriksa & mengirim menyediakan file python dan file data sebagai argumen. Anda kemudian akan diminta memilih salah satu opsi 1 (validasi) atau 2 (validasi dan kirim):

 >>> 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. Untuk menjalankan validasi atau memeriksa & mengirim menyediakan file python, file data dan nomor apa pun selain 1 atau 2 sebagai argumen. Anda kemudian akan diminta memilih salah satu opsi 1 (validasi) atau 2 (validasi dan kirim), karena tidak ada nomor lain yang menjadi opsi:

 >>> 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. Anda dapat menghindari prompt yang ditampilkan kepada Anda sama sekali. Untuk memvalidasi file data orang ulang tahun untuk kesalahan, atur argumen kedua menjadi 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. Untuk memeriksa file data orang ulang tahun dan mengirim email, atur argumen kedua menjadi 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> harus terlihat seperti ini - dataset/data_20.csv, tetapi di direktori Anda. Jalur lengkap bagi saya adalah/pengguna/aurimasnausedas/documents/python/birthdayreminderapp/datasets/data_20.csv

² Modul utama mengambil dua argumen saat dijalankan dari konsol.

³ Data yang digunakan untuk contoh adalah data_20.csv pada ^tanggal 23 Juni 2022.

Fungsi

Tinjauan fungsi yang ditemukan di dalam modul - bdayreminder.py :

• validate_data_and_send_emails (input_file, send_emails) memeriksa validitas input_file dan apakah ulang tahun dalam seminggu serta secara opsional mengirimkan email masing -masing ( send_emails ).
• parse_date (tanggal) parses tanggal .
• is_valid_input (date_format, item, index, to_print) memvalidasi input ( date_format , item , index , to_print ).
• send_multiple_emails (ulang tahun_individuals, to_send) mengirim email ke penerima daftar TO_SEND .
• is_date_in_past (date, date_format) terlihat jika tanggal ada di masa lalu.
• is_valid_email (email) memeriksa apakah email itu valid.
• send_email (name, bday_name, bday_date, days_left, to_email) mengirim email ke penerima ( nama , to_email ) sebagai pengingat ulang tahun ( bday_name , bday_date ) di muka ( hari_left ).
• Jalankan (read_path, cron_value) mengambil file data CSV dan menjalankan skrip tanpa pilihan disahkan sebagai argumen ( read_path , cron_value ).
• pilih_options (read_path) meminta input ( read_path ) dan memilih opsi untuk dijalankan.

Penjelasan mendalam tentang fungsi dapat ditemukan di dalam modul - bdayreminder.py.

Kumpulan data

Ada tiga kemungkinan set data untuk digunakan. Ini adalah data_20 dari 20 penerima, data_50 dari 50 penerima dan data_80 dari 80 penerima.

Tes

Tinjauan fungsi yang ditemukan di dalam modul - tests.py:

• test_correct_parse_date_ymd () menguji jika tanggal yang benar diuraikan.
• test_correct_parse_date_md () menguji jika tanggal yang benar diuraikan.
• test_is_date_in_past_old () menguji jika tanggal lama di masa lalu.
• test_is_date_in_past_future () menguji jika tanggal masa depan di masa lalu.
• test_is_date_in_past_past_month_day () menguji jika tanggal lama di masa lalu.
• test_is_valid_email_good () tes jika alamat email valid.
• test_is_valid_email_bad () Tes Jika alamat email tidak valid.

Dengan menavigasi ke folder program/aplikasi di mana ia diekstraksi - ulang tahun ReminderApp - satu folder sebelum di mana tests.py diadakan dan seseorang dapat menjalankan perintah uji ini:

1. Untuk memeriksa file sumber untuk kesalahan di folder proyek:

 >>> pyflakes .

2. Untuk memeriksa file sumber untuk kesalahan dalam file uji:

 >>> pyflakes Tests/tests.py

3. Untuk memeriksa pengetikan file uji:

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

Kesalahan

Mungkin ada beberapa kesalahan seperti:

1. Kesalahan Argumen Pertama Jika argumen pertama yang disediakan memiliki format yang berbeda dengan format 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. Kesalahan Argumen Pertama Jika argumen pertama yang disediakan dari file data tidak ada:

 >>> 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. Kesalahan Argumen ke -2 Jika argumen ke -2 yang disediakan adalah string:

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

Masih ada lagi yang paling umum.

Pekerjaan cron

Untuk membangun pekerjaan cron di Mac Terminal Run:

 >>> crontab -e

Sintaks untuk cronjob saat memasuki terminal bisa terlihat seperti ini: ^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> - harus menjadi direktori di mana folder ulang tahun rigereminderApp seperti/pengguna/aurimasnausedas/dokumen/python/ulang tahunreminderapp

² <Directory_to_python> harus berada di tempat Anda menginstal python pada mesin Anda seperti/pengguna/aurimasnausedas/opt/miniconda3/envs/simetris/bin/python

³ <date_file_path> harus menjadi dataset di direktori aplikasi seperti di/user/aurimasnausedas/documents/python/breatereminderapp dengan mengaturnya ke dataset/data_20.csv

Kustomisasi sintaks untuk pekerjaan cron dapat diperiksa di sini.

Publik

Folder publik berisi tiga file:

• ulang tahun. Txt - output dari pekerjaan cron setelah menerapkan perintah [opsional] seperti yang diberikan di bidang pekerjaan cron.
• Todolist - daftar yang harus dilakukan.

Logo

Logo aplikasi pengingat ulang tahun dapat ditemukan di sini.

Lisensi

Lisensi MIT