View source for OPS435 Assignment 1 for Section B

[[Category:OPS435-Python]][[Category:rchan]]
= Overview =
When applying for a bank account, accepting a job, or some other activity that is personal, it may involve the processing of someone's date of birth. It is critical for this type of data to be validated before being processed by a computation system.  

The task for this assignment is to design an algorithm and write a python script to validate a given string in various forms as the date of birth of someone and convert it into a standard format. The DOB conversion script should take a date in the following four formats: "YYYYMMDD", "YYYY/MM/DD", "YYYY-MM-DD", and "YYYY.MM.DD" format and return the date in a standard format: 'mmm d, yyyy", where "mmm" is the three letter abbreviated month's name, 'd' is a one or two-digit day of the month, and 'yyyy' is the four-digit year. That is, if the user enters "20201007", or "2020-10-07", or "2020/10/07", or "2020.10.07", the script will return "Oct 7, 2020". More examples to follow.

= Assignment Requirements =
== The First Checkpoint (Oct 13) ==
* Before you begin coding in Python, it is important to plan your algorithm. Therefore your first task will be to complete and submit an algorithm document. This document should be named '''algorithm_[student_id].txt'''. This file should be plaintext. The document will contain two sections:
:* <code>A description of how your main program works. The main program flow is provided to you in a1_template.py. Open the file, and use clear English to describe what each line of code does in such a way that a competent Python coder could reproduce the code without seeing it firsthand.</code>
:* <code>You will then apply the same principles to create an algorithm for each validation function named in the a1_template.py file. Inside the code, if you are calling another function like "leap_year()", you may simply describe what the function will return, and not the operation of the function itself.</code> 
* This file should be submitted to Blackboard by Oct 13, 2020, and should be your first priority. The objective of the first checkpoint is not to have a 100% perfect algorithm, but to plan ahead and anticipate challenges and issues with the assignment. The first checkpoint will also allow your professor an opportunity to give you feedback before the assignment overall due date.
* [https://simple.m.wikipedia.org/wiki/Algorithm Here is an basic introduction to Algorithm]
* While you are working on the step-by-step instructions, note that there are different number of days in each month and some years have 365 days and some years have 366 days.
* Since we don't think we are going to encounter someone who is 120 years or older, your algorithm can consider a date of birth before year 1900 as invalid. Could you think of other limit you should put on someone's date of birth?

== The 2nd Checkpoint - your drafted Python Script (Oct 16) ==
* As stated before, your code will be inside the file "a1_[Seneca_name].py". The first step will be to clone the Assignment 1 template repository (https://github.com/rayfreeping/ops435-a1). Once you clone the repository, run this command: "cp a1_template.py a1_[Seneca_name].py". (Replace Seneca_name with your Seneca account user name). Begin coding your algorithm into Python code that is required. Additional requirements are outlined below.
* Your should update the author and date information in your Python script.
* Your Python script file a1_[Seneca_name].py should be submitted to Blackboard by Oct 16, 2020. * The script doesn't have to be perfect and error free. However, it shouldn't contain any syntax errors when exectued.
* This intern submission is just to show that you are activity working on your assignment.

== The 3rd Checkpoint - preliminary test results (Oct 20) ==
* Run the preliminary test script named "checkA1.py" in the "tests" sub-folder of the ops435-a1 repository mentioned above.
* Please read the readme.txt in the tests sub-folder for more information about the purpose of the preliminary test script.
* When your are satisfy with the test result, capture the test result to a file named a1_pretest.txt and submit it together with your Python script a1_[Seneca_name].py to Blackboard by Oct 20, 2020.

== Python Coding Requirements ==
=== Required Modules and Functions ===
<b><font color='blue'>Your python script is allowed to call all the built-in functions and the functions imported from the <u>os, subprocess and sys</u> modules from the standard library.</font></b>

Based on the algorithm you have designed for this assignment, you should at least have the following four functions defined in your python script (see later section on the purpose of each function):
* leap_year()
* range_check()
* sanitize()
* size_check()
* usage()

=== Coding Standard ===
Your python script must follow the following coding guide:
* [https://www.python.org/dev/peps/pep-0008/ PEP-8 -- Style Guide for writing Python Code]

=== Command Line Argument to be supported ===
* Your Python script must support one command line argument only: date in the following format with correct values in YYYY, MM, and DD should be considered as valid input data:
** <code>YYYYMMDD</code>
** <code>YYYY/MM/DD</code>
** <code>YYYY-MM-DD</code>
** <code>YYYY.MM.DD</code> 
* If there are no argument, more than one argument, or an invalid year, month, or day, your script should display the appropriate usage message, error code, and exit.

=== Documentation ===
* Please use python's docstring to document your python script 
** script level documentation, and 
** function level documention for each function you created for this assignment. 
* The docstring should describe 'what' the function does, not 'how' it does.

=== Authorship Declaration ===
All your Python code for this assignment must be placed in a <font color='red'><b><u>single source python file</u></b></font>. Please complete  the declaration <b><u>as part of the docstring</u></b> in your Python source code file (replace "Student Name" with your own name).

=== Github Commits === 
You will be graded partly on the quality and transaction activities of your Github commits. Professionals generally follow these guidelines:
* commit their code after every significant change, 
* the code should run without syntax errors after each commit, and
* every commit has a descriptive commit message.
These guidelines are not always possible, but you are expected to follow these guidelines as much as possible. Break your problem into smaller pieces, and work iteratively to solve each small problem. Test your code after each small change you make, and address errors as soon as they arise. It will make your coding life easier!

== Tests and Test results ==
You must name your python 3 script as <code>a1_[Seneca_name].py</code>. The following examples assumes that the Seneca_name is rchan. The script should accept one command line argument, the argument can be either in "YYYYMMDD", "YYYY/MM/DD", "YYYY-MM-DD", or "YYYY.MM.DD" format. If the input data does not represent a real date, your script should give an appropriate error message. Invalid months (>12) or invalid days of month(different for each month, and if the month is February, the year matter too), should be detected and give appropriate error messages. For examples:
* <b><code>python3 a1_rchan.py 2020-10-10</code></b>, and the output should be<br />
     Oct 10, 2020
* <b><code>python3 a1_rchan.py 2020-10-09</code></b>, and the output should be<br />
     Oct 9, 2020
* <b><code>python3 a1_rchan.py 2020-06-30</code></b>, and the output should be<br />
     Jun 30, 2020
* <b><code>python3 a1_rchan.py 20201010</code></b>, and the output should be<br />
     Oct 10, 2020
* <b><code>python3 a1_rchan.py 2020/10/10</code></b>, and the output should be<br />
     Oct 10, 2020
* <b><code>python3 a1_rchan.py 2020.02.29</code></b>, and the output should be<br />
     Feb 29, 2020
* <b><code>python3 a1_rchan.py 2019.02.28</code></b>, and the output should be<br />
     Error 03: wrong day entered
* <b><code>python3 a1_rchan.py 2019.13.12</code></b>, and the output should be<br />
     Error 02: wrong month entered
* <b><code>python3 a1_rchan.py 2019.06.31</code></b>, and the output should be<br />
     Error 03: wrong day entered
* <b><code>python3 a1_rchan.py 201802</code></b>, and the output should be<br />
     Error 09: wrong date entered
* <b><code>python3 a1_rchan.py 18981225</code></b>, and the output should be <br />
     Error 10: year out of range, must be 1900 or later
* <b><code>python3 a1_rchan.py 18981299</code></b>, and the output should be <br />
     Error 10: year out of range, must be 1900 or later
* <b><code>python3 a1_rchan.py 189802</code></b>, and the output should be<br />
     Error 09: wrong data entered


If there is too few or too many command line argument given, display the proper usage:
* <code>Usage: a1_rchan.py YYYYMMDD|YYYY/MM/DD|YYYY-MM-DD|YYYY.MM.DD </code>

== Script structure and sample template ==

The following is a brief description of each function:
* The leap_year() function will take a year in "YYYY" format, and return True if the given year is a leap year, otherwise return False.
* The range_check() function will take an integer object and a tuple with two integer values, the first value indicates the lower bound and the second one indicates the upper bound of a integer range. If the integer object falls in between the range given in the tuple, return 'True', otherwise return 'False'.
* The sanitize() function will take two string objects, the first string object is the object to be sanitized, and the 2nd string object contains letters that are allowed. This function will return the first object with letters not in the 2nd string object removed.
* The size_check() function will take an collection data type object and expected number of items as an integer and will return either 'True' or 'False'. If the number of items in the data object match the integer value given, return 'True', otherwise return 'False'
* The usage() function will take no argument and return a string describing the usage of the script.

= Rubric =

{| class="wikitable" border="1"
! Task !!  Maximum mark !! Actual mark
|-
| Program Authorship Declaration || 5 ||
|-
| Check script passed || 30 ||
|-
| size_check() function design || 4 ||
|-
| sanitize() function design || 4 ||
|-
| leap_year() function design || 4 ||
|-
| range_check() function design || 4 ||
|-
| usage() function design || 4 ||
|-
| script level docstring || 5 ||
|-
| function level docstring || 5 ||
|-
| First Checkpoint ||10||
|-
| Second Checkpoint || 10 ||
|-
| github.com repository: Commit messages and use ||15||
|-
|'''Total''' || 100 || 

|}

= Due Date and Final Submission requirement =

Check with your professor for the due date for your section.

Please submit the following files by the due date:
* [ ] your algorithm document, named as 'algorithm_username.txt', to Blackboard.
* [ ] your python script, named as 'a1_[seneca-id].py', should be included in your repository, and also '''submitted to Blackboard.'''
* [ ] the output of the checking script checkA1.py, named as 'a1_output.txt', should be included in your repository.
* [ ] your debrief document should be submitted to Blackboard.